|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.basistech.rlp.RLPEnvironment
public class RLPEnvironment
The RLP Environment class, which maintains the location of the available processors for RLP.
Nested Class Summary | |
---|---|
static interface |
RLPEnvironment.LogCallback
Interface for objects that accept RLP log messages. |
Constructor Summary | |
---|---|
RLPEnvironment(EnvironmentParameters params)
Constructs a new RLPEnvironment object. |
Method Summary | |
---|---|
void |
close()
Explicitly releases resources. |
void |
finalize()
Explicitly releases resources. |
RLPContext |
getContext(ContextParameters params)
Creates a new RLPContext within the Environment. |
RLPContext |
getContextFromBuffer(String contextDefinition)
Obtains a new context object that uses the configuration in the environment. |
RLPContext |
getContextFromFile(String contextDefinitionPath)
Obtains a new context object that uses the configuration in the environment. |
String |
getProcessorReport()
Obtains a string describing all the processors defined in this environment. |
boolean |
hasLicenseForLanguage(LanguageCode language,
int functionality)
Determines if a license exists for the specified language and functionality. |
boolean |
hasLicenseForNamedFeature(String feature,
int functionality)
Determines if a license exists for the feature and functionality. |
boolean |
hasLicenses()
Determines if the license contains a valid license. |
void |
initialize()
Initializes the RLPEnvironment, this must be done before creating contexts. |
void |
initializeFromFile(String pathname)
Configures the environment from XML information stored in a file. |
static String |
versionString()
Retrieves the version String. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public RLPEnvironment(EnvironmentParameters params)
params
- Paramaters to use when it is initialized by initialize()
.Method Detail |
---|
public void initialize() throws RLPException
RLPException
- Indicates initialization failed.public void finalize()
finalize
in class Object
close()
public void close()
public RLPContext getContext(ContextParameters params) throws RLPException
params
- Object specifying the parameters of the new context. This object is cloned and can therefore be reused.
RLPException
- Indicates uninitialized environment or trouble creating the context.public void initializeFromFile(String pathname) throws RLPException
pathname
- A file containing the configuration in XML.
RLPException
- Indicates an error initializing the environment from the specified file.public RLPContext getContextFromFile(String contextDefinitionPath) throws RLPException, IOException
contextDefinitionPath
- The pathname of a file containing
the context definition in XML.
RLPException
- Indicates an error creating a context from the specified configuration.
IOException
- Indicates file I/O failure.public RLPContext getContextFromBuffer(String contextDefinition) throws RLPException
contextDefinition
- A string containing the context
definition in XML.
RLPException
- Indicates an error creating the context.public String getProcessorReport() throws RLPException
ProcName0|ProcDescription0|ProcName1|ProcDescription1|...||.
RLPException
- Indicates uninitialized environment or trouble creating the report.public static String versionString()
public boolean hasLicenses() throws RLPException
RLPException
- Indicates uninitialized environment or trouble reading licenses.public boolean hasLicenseForLanguage(LanguageCode language, int functionality) throws RLPException
language
- Language.functionality
- Functionality.
RLPException
- indicates uninitialized environment or trouble reading licenses.LanguageCode
,
RLPConstants
public boolean hasLicenseForNamedFeature(String feature, int functionality) throws RLPException
feature
- Feature.functionality
- Functionality.
RLPException
- indicates uninitialized environment or trouble reading licenses.RLPConstants
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |