org.apache.flex.compiler.config

Class RSLSettings

java.lang.Object

org.apache.flex.compiler.config.RSLSettings

public class RSLSettings
extends Object

The runtime RSL settings for a given library. The specified library will have all of its symbols removed from the application. The runtime RSL settings are written in the root class of the application and read in frame1 of application.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RSLSettings.RSLAndPolicyFileURLPair A RSL URL and a policy file URL.

Constructor Summary

Constructors

Constructor and Description
RSLSettings(File libraryFile) Create RSLSettings with: - a default ApplicationDomainTarget - verify digest set to true

Method Summary

Methods

Modifier and Type	Method and Description
void	addRSLURLAndPolicyFileURL(String rslURL, String policyFileURL) Add a new RSL URL and Policy file URL.
ApplicationDomainTarget	getApplicationDomain() One of ApplicationDomainTarget that control which domain an RSL is loaded into.
File	getLibraryFile()
List<RSLSettings.RSLAndPolicyFileURLPair>	getRSLURLs()
boolean	getVerifyDigest()
boolean	isForceLoad()
static boolean	isSignedRSL(String url) Test if the url is a signed RSL.
void	setApplicationDomain(ApplicationDomainTarget applicationDomain)
void	setForceLoad(boolean forceLoad) Sets a flag on the RSL so the compiler is not allowed to remove it when the "remove unused RSLs" feature is on.
void	setVerifyDigest(boolean verifyDigest) Change the value of the verify digests flag.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RSLSettings

public RSLSettings(File libraryFile)

Create RSLSettings with: - a default ApplicationDomainTarget - verify digest set to true

Parameters:

libraryFile - the library whose classes will be removed from the application. May not be null.

Throws:

NullPointerException - if libraryFile is null.

Method Detail

isSignedRSL

public static boolean isSignedRSL(String url)

Test if the url is a signed RSL. Signed RSL have a .swz extension.

Parameters:

url - url to test, the file specified by the url does not need to exist.

Returns:

true if the url specifies a signed rsl, false otherwise.

isForceLoad

public boolean isForceLoad()

Returns:

true if the RSL should be force loaded, false otherwise.

setForceLoad

public void setForceLoad(boolean forceLoad)

Sets a flag on the RSL so the compiler is not allowed to remove it when the "remove unused RSLs" feature is on.

Parameters:

forceLoad - true to force the RSL to be loaded at runtime, false otherwise.

getRSLURLs

public List<RSLSettings.RSLAndPolicyFileURLPair> getRSLURLs()

Returns:

a List of RSLSettings.RSLAndPolicyFileURLPair

addRSLURLAndPolicyFileURL

public void addRSLURLAndPolicyFileURL(String rslURL,
                             String policyFileURL)

Add a new RSL URL and Policy file URL. This first pair is the primary RSL and the following RSLs are failover RSLs.

Parameters:

rslURL - A String representing the URL to load the RSL from. May not be null.

policyFileURL - A String representing the URL to load a policy file from. This is optional and may be null to indicate there is no policy file.

Throws:

NullPointerException - if rslURL is null.

getLibraryFile

public File getLibraryFile()

Returns:

the libraryFile

setApplicationDomain

public void setApplicationDomain(ApplicationDomainTarget applicationDomain)

Parameters:

applicationDomain - the new value of the applicationDomain.

getApplicationDomain

public ApplicationDomainTarget getApplicationDomain()

One of ApplicationDomainTarget that control which domain an RSL is loaded into.

Returns:

the applicationDomain

setVerifyDigest

public void setVerifyDigest(boolean verifyDigest)

Change the value of the verify digests flag.

Parameters:

verifyDigest - The new value of the verify digests flag.

getVerifyDigest

public boolean getVerifyDigest()

Returns:

if true, the RSL's digest must be verified at runtime.