|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object atg.nucleus.logging.VariableArgumentApplicationLoggingImpl atg.nucleus.GenericService atg.rest.security.RestSecurityManager
public class RestSecurityManager
This class manages Rest security configuration. It is responsible for initialization of the Rest security configuration from Rest security definition files. In addition it provides runtime Rest security checks for current profile user.
Field Summary | |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string |
static int |
WILDCARD_CACHE_SIZE
|
Fields inherited from class atg.nucleus.GenericService |
---|
SERVICE_INFO_KEY |
Fields inherited from interface atg.nucleus.logging.TraceApplicationLogging |
---|
DEFAULT_LOG_TRACE_STATUS |
Fields inherited from interface atg.nucleus.logging.ApplicationLogging |
---|
DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS |
Constructor Summary | |
---|---|
RestSecurityManager()
Default Constructor |
Method Summary | |
---|---|
protected void |
addSecurityConfiguration(org.w3c.dom.Document pDocument)
Adds Rest security configuration(s) for the given XML Document object |
void |
doStartService()
This is called after a Service has been created, placed into the naming hierarchy, and initialized with its configured property values. |
ComponentResolver |
getComponentResolver()
|
ComponentSecurityConfiguration |
getComponentSecurityConfiguration(java.lang.String pComponentName)
Gets ComponentSecurityConfiguration |
java.util.Map<java.lang.String,ComponentSecurityConfiguration> |
getComponentSecurityConfigurations()
|
ComponentSecurityConfiguration |
getDefaultComponentSecurityConfiguration()
|
RestConfiguration |
getRestConfiguration()
|
atg.xml.XMLFile[] |
getRestSecurityDefinitionFiles()
|
SecurityConfiguration |
getSecurityConfiguration()
|
ComponentSecurityConfiguration |
getWildCardComponentSecurityConfiguration(java.lang.String pComponentName)
Given a componentName, returns a wild card ComponentSecurityConfiguration. |
protected java.lang.String |
getWildCardName(java.lang.String pComponentName)
Given a component name, returns a wild card name for the component. |
protected java.util.ArrayList<java.lang.String> |
getWildCardNames(java.lang.String pComponentName)
Given a component name, returns a list of wild card name for the component. |
atg.xml.tools.XMLToDOMParser |
getXMLToDOMParser()
|
atg.xml.tools.XMLToolsFactory |
getXMLToolsFactory()
|
protected void |
initializeRestSecurityConfiguration(atg.xml.XMLFile[] pFiles)
Initializes the Rest security configuration by parsing the configuration files |
boolean |
isCheckFormHandlerProperties()
|
boolean |
isWarnSecureSetting()
|
void |
setCheckFormHandlerProperties(boolean pCheckFormHandlerProperties)
|
void |
setComponentResolver(ComponentResolver pComponentResolver)
|
void |
setDefaultComponentSecurityConfiguration(ComponentSecurityConfiguration pDefaultComponentSecurityConfiguration)
|
void |
setRestConfiguration(RestConfiguration pRestConfiguration)
|
void |
setRestSecurityDefinitionFiles(atg.xml.XMLFile[] pRestSecurityDefinitionFiles)
|
void |
setSecurityConfiguration(SecurityConfiguration pSecurityConfiguration)
|
void |
setWarnSecureSetting(boolean pWarnSecureSetting)
|
void |
setXMLToolsFactory(atg.xml.tools.XMLToolsFactory pXMLToolsFactory)
|
Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl |
---|
vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogDebugTrace, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String CLASS_VERSION
public static int WILDCARD_CACHE_SIZE
Constructor Detail |
---|
public RestSecurityManager()
Method Detail |
---|
public void setRestSecurityDefinitionFiles(atg.xml.XMLFile[] pRestSecurityDefinitionFiles)
pRestSecurityDefinitionFiles
- The restSecurityDefinitionFiles to set.public atg.xml.XMLFile[] getRestSecurityDefinitionFiles()
public void setXMLToolsFactory(atg.xml.tools.XMLToolsFactory pXMLToolsFactory)
pXMLToolsFactory
- new value to setpublic atg.xml.tools.XMLToolsFactory getXMLToolsFactory()
public atg.xml.tools.XMLToDOMParser getXMLToDOMParser()
public void setSecurityConfiguration(SecurityConfiguration pSecurityConfiguration)
pSecurityConfiguration
- new value to setpublic SecurityConfiguration getSecurityConfiguration()
public void setRestConfiguration(RestConfiguration pRestConfiguration)
pRestConfiguration
- new value to setpublic RestConfiguration getRestConfiguration()
public void setComponentResolver(ComponentResolver pComponentResolver)
pComponentResolver
- new value to setpublic ComponentResolver getComponentResolver()
public void setWarnSecureSetting(boolean pWarnSecureSetting)
pWarnSecureSetting
- new value to setpublic boolean isWarnSecureSetting()
public void setCheckFormHandlerProperties(boolean pCheckFormHandlerProperties)
pCheckFormHandlerProperties
- - whether to check security for form handler properties or notpublic boolean isCheckFormHandlerProperties()
public java.util.Map<java.lang.String,ComponentSecurityConfiguration> getComponentSecurityConfigurations()
public void setDefaultComponentSecurityConfiguration(ComponentSecurityConfiguration pDefaultComponentSecurityConfiguration)
pDefaultComponentSecurityConfiguration
- new value to setpublic ComponentSecurityConfiguration getDefaultComponentSecurityConfiguration()
public void doStartService() throws ServiceException
GenericService
doStartService
in class GenericService
ServiceException
- if the Service had a problem starting upprotected void initializeRestSecurityConfiguration(atg.xml.XMLFile[] pFiles) throws ServiceException
pFiles
- the Rest security configuration file(s)
ServiceException
- if errors occur while parsing the configuration files.protected void addSecurityConfiguration(org.w3c.dom.Document pDocument) throws RestInitializationException
pDocument
- the XML Document object to read and use to configure the SecurityManager
RestInitializationException
- if errors occur while adding security configuration(s).public ComponentSecurityConfiguration getComponentSecurityConfiguration(java.lang.String pComponentName)
pName
- The component name.
protected java.lang.String getWildCardName(java.lang.String pComponentName)
pComponentName
-
protected java.util.ArrayList<java.lang.String> getWildCardNames(java.lang.String pComponentName)
pComponentName
-
public ComponentSecurityConfiguration getWildCardComponentSecurityConfiguration(java.lang.String pComponentName)
pComponentName
-
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |