sapphire.accessor

Class ConfigurationProcessor

java.lang.Object

com.labvantage.sapphire.BaseClass

com.labvantage.sapphire.BaseAccessor

sapphire.accessor.ConfigurationProcessor

public class ConfigurationProcessor
extends com.labvantage.sapphire.BaseAccessor

Provides access to configuration settings

Field Summary

Fields inherited from class com.labvantage.sapphire.BaseAccessor

jndiPrefix, local, localJNDIPrefix, remoteAccessKey

Fields inherited from class com.labvantage.sapphire.BaseClass

FAILURE, SUCCESS

Constructor Summary

Constructors

Constructor and Description
ConfigurationProcessor(java.io.File rakFile, java.lang.String connectionid) Constructor for a client application with an existing connection
ConfigurationProcessor(javax.servlet.jsp.PageContext pageContext) Constructor for a client web application with a page Context and existing connectionid
ConfigurationProcessor(java.lang.String connectionid) Constructor for creating an accessor from components

Method Summary

Modifier and Type	Method and Description
PropertyList	findPolicy(java.lang.String policyid, java.lang.String propertyid, java.lang.String propertyvalue) Return a PropertyList representing the requested policy
PropertyList	getPolicy(java.lang.String policyid) Return a PropertyList representing the requested policy
PropertyList	getPolicy(java.lang.String policyid, java.lang.String nodeid) Return a PropertyList representing the requested policy
PropertyList	getPolicy(java.lang.String policyid, java.lang.String nodeid, boolean translate) Return a PropertyList representing the requested policy
java.lang.String	getProfileProperty(java.lang.String propertyid) Return a profiile property for the current user.
java.lang.String	getProfileProperty(java.lang.String propertyid, java.lang.String defaultValue) Return a profiile property for the current user.

Methods inherited from class com.labvantage.sapphire.BaseAccessor

createRemoteAccessKey, getAttachmentManager, getAutomationManager, getConfigurationManager, getConnectionid, getErrorCodeList, getErrorCodeStack, getErrorHandler, getErrorStack, getErrorStack, getErrorString, getInfoErrorString, getLastError, getLastErrorCode, getLastErrorMessage, getLastException, getLocalAccessManager, getNameserverlist, getQueryManager, getRemoteAccessManager, getRequestManager, getStatusManager, getWebAdminManager, hasErrors, hasInfoErrors, parseServiceExceptionMsg, resetConnectionid, resetErrorStack, setConnectionDetails, setConnectionid, setError, setError, setErrorString, setInfoErrorString, setJNDIPrefix, setLocal, setLocalJNDIPrefix, setRakFile

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigurationProcessor

public ConfigurationProcessor(java.lang.String connectionid)

Constructor for creating an accessor from components

Parameters:

connectionid - The connection to use for component calls

ConfigurationProcessor

public ConfigurationProcessor(java.io.File rakFile,
                              java.lang.String connectionid)

Constructor for a client application with an existing connection

Parameters:

rakFile - A remote access key file

connectionid - A valid connectionid

ConfigurationProcessor

public ConfigurationProcessor(javax.servlet.jsp.PageContext pageContext)

Constructor for a client web application with a page Context and existing connectionid

Parameters:

pageContext - The current page context

Method Detail

getProfileProperty

public java.lang.String getProfileProperty(java.lang.String propertyid)

Return a profiile property for the current user.

Parameters:

propertyid - Profile property to look for

Returns:

The profile property value

getProfileProperty

public java.lang.String getProfileProperty(java.lang.String propertyid,
                                           java.lang.String defaultValue)

Return a profiile property for the current user.

Parameters:

propertyid - Profile property to look for

defaultValue - Default value

Returns:

The profile property value

getPolicy

public PropertyList getPolicy(java.lang.String policyid)
                       throws SapphireException

Return a PropertyList representing the requested policy

Parameters:

policyid - The name of the Policy.

Returns:

A PropertyList representing the requested policy for node "Default"

Throws:

SapphireException

getPolicy

public PropertyList getPolicy(java.lang.String policyid,
                              java.lang.String nodeid)
                       throws SapphireException

Return a PropertyList representing the requested policy

Parameters:

policyid - The name of the Policy.

nodeid - The specific node for the policy

Returns:

A PropertyList representing the requested policy

Throws:

SapphireException

getPolicy

public PropertyList getPolicy(java.lang.String policyid,
                              java.lang.String nodeid,
                              boolean translate)
                       throws SapphireException

Return a PropertyList representing the requested policy

Parameters:

policyid - The name of the Policy.

nodeid - The specific node for the policy

translate - Whether to translate properties marked to be translated or not.

Returns:

A PropertyList representing the requested policy

Throws:

SapphireException

findPolicy

public PropertyList findPolicy(java.lang.String policyid,
                               java.lang.String propertyid,
                               java.lang.String propertyvalue)

Return a PropertyList representing the requested policy

Parameters:

policyid - The name of the Policy.

propertyid - The property to search for in the policy

propertyvalue - The value of the property required

Returns:

A PropertyList representing the requested policy