atg.rest.security
Class MethodSecurityConfiguration

java.lang.Object
  atg.security.GenericSecuredObject
      atg.rest.security.RestSecurityConfiguration
          atg.rest.security.MethodSecurityConfiguration

All Implemented Interfaces:

atg.security.SecuredObject, java.io.Serializable

public class MethodSecurityConfiguration
extends RestSecurityConfiguration

The SecuredObject for a method.

Author:

bzhang

See Also:

GenericSecuredObject, RestSecurityConfiguration, Serialized Form

Field Summary

static java.lang.String

CLASS_VERSION Class version string

Fields inherited from class atg.security.GenericSecuredObject

mAcl, mOwner, mSecurityContext

Constructor Summary

protected	MethodSecurityConfiguration(java.lang.String pName, java.lang.String pSignature, java.lang.String pComponent, boolean pSecure, java.lang.String pAcl, atg.security.SecurityConfiguration pSecurityConfiguration) Constructor
protected	MethodSecurityConfiguration(java.lang.String pName, java.lang.String pSignature, java.lang.String pComponent, java.lang.String pFormHandlerErrorURLProperty, boolean pRequiresSessionConfirmation, boolean pSecure, java.lang.String pAcl, atg.security.SecurityConfiguration pSecurityConfiguration) Constructor

Method Summary

static MethodSecurityConfiguration	create(java.lang.String pName, java.lang.String pSignature, java.lang.String pComponent, boolean pSecure, java.lang.String pAcl, atg.security.SecurityConfiguration pSecurityConfiguration) Factory method for creating MethodSecurityConfiguration objects
static MethodSecurityConfiguration	create(java.lang.String pName, java.lang.String pSignature, java.lang.String pComponent, java.lang.String pFormHandlerErrorURLProperty, boolean pRequiresSessionConfirmation, boolean pSecure, java.lang.String pAcl, atg.security.SecurityConfiguration pSecurityConfiguration) Factory method for creating MethodSecurityConfiguration objects
java.lang.String	getFormHandlerErrorURLProperty()
java.lang.String	getSignature()
boolean	isRequiresSessionConfirmation()
void	setFormHandlerErrorURLProperty(java.lang.String pFormHandlerErrorURLProperty)
void	setRequiresSessionConfirmation(boolean pRequiresSessionConfirmation)
void	setSignature(java.lang.String pSignature)
java.lang.String	toString()

Methods inherited from class atg.rest.security.RestSecurityConfiguration

getComponent, getName, getSecurityConfiguration, hasAccess, hasAcl, isSecure, setAcl, setComponent, setName, setSecure, setSecurityConfiguration

Methods inherited from class atg.security.GenericSecuredObject

checkAccess, checkRuntimeAccess, getAccessControlList, getOwner, getSecurityContext, setAccessControlList, setOwner, setSecurityContext, supportsAccessControlList, supportsOwner, unsecuredGetAccessControlList, unsecuredGetContainers, unsecuredGetOwner, unsecuredGetSecuredContainers, unsecuredSetAccessControlList, unsecuredSetCreationSecurity, unsecuredSetOwner

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_VERSION

public static final java.lang.String CLASS_VERSION

Class version string

See Also:

Constant Field Values

Constructor Detail

MethodSecurityConfiguration

protected MethodSecurityConfiguration(java.lang.String pName,
                                      java.lang.String pSignature,
                                      java.lang.String pComponent,
                                      boolean pSecure,
                                      java.lang.String pAcl,
                                      atg.security.SecurityConfiguration pSecurityConfiguration)
                               throws atg.security.SecurityException

Constructor

Parameters:

pName - The method name

pSignature - The method signature

pComponent - The component

pSecure - Is secure?

pAcl - The acl

pSecurityConfiguration - The SecurityConfiguration

Throws:

atg.security.SecurityException

MethodSecurityConfiguration

protected MethodSecurityConfiguration(java.lang.String pName,
                                      java.lang.String pSignature,
                                      java.lang.String pComponent,
                                      java.lang.String pFormHandlerErrorURLProperty,
                                      boolean pRequiresSessionConfirmation,
                                      boolean pSecure,
                                      java.lang.String pAcl,
                                      atg.security.SecurityConfiguration pSecurityConfiguration)
                               throws atg.security.SecurityException

Constructor

Parameters:

pName - The method name

pSignature - The method signature

pComponent - The component

pSecure - Is secure?

pAcl - The acl

pSecurityConfiguration - The SecurityConfiguration

Throws:

atg.security.SecurityException

Method Detail

getSignature

public java.lang.String getSignature()

Returns:

the value of signature

setSignature

public void setSignature(java.lang.String pSignature)

Parameters:

pSignature - the signature to set

getFormHandlerErrorURLProperty

public java.lang.String getFormHandlerErrorURLProperty()

Returns:

the optional error URL property on a form handler that allows REST to process error redirects

setFormHandlerErrorURLProperty

public void setFormHandlerErrorURLProperty(java.lang.String pFormHandlerErrorURLProperty)

Parameters:

pFormHandlerErrorURLProperty - the optional error URL property on a form handler that allows REST to process error redirects

isRequiresSessionConfirmation

public boolean isRequiresSessionConfirmation()

Returns:

for form handlers, does this require session confirmation

setRequiresSessionConfirmation

public void setRequiresSessionConfirmation(boolean pRequiresSessionConfirmation)

Parameters:

pRequiresSessionConfirmation - for form handlers, does this require session confirmation

create

public static MethodSecurityConfiguration create(java.lang.String pName,
                                                 java.lang.String pSignature,
                                                 java.lang.String pComponent,
                                                 boolean pSecure,
                                                 java.lang.String pAcl,
                                                 atg.security.SecurityConfiguration pSecurityConfiguration)
                                          throws RestInitializationException

Factory method for creating MethodSecurityConfiguration objects

Parameters:

pName - The method name

pSignature - The method signature

pComponent - The component

pSecure - Is secure?

pAcl - The acl

pSecurityConfiguration - The SecurityConfiguration

Returns:

Returns a new MethodSecurityConfiguration

Throws:

RestInitializationException

create

public static MethodSecurityConfiguration create(java.lang.String pName,
                                                 java.lang.String pSignature,
                                                 java.lang.String pComponent,
                                                 java.lang.String pFormHandlerErrorURLProperty,
                                                 boolean pRequiresSessionConfirmation,
                                                 boolean pSecure,
                                                 java.lang.String pAcl,
                                                 atg.security.SecurityConfiguration pSecurityConfiguration)
                                          throws RestInitializationException

Factory method for creating MethodSecurityConfiguration objects

Parameters:

pName - The method name

pSignature - The method signature

pComponent - The component

pFormHandlerErrorURLProperty - For form handlers, optional error URL property. It allows REST to handle error redirects

pRequiresSessionConfirmation - For form handlers, whether it requires the session confirmation number

pSecure - Is it secured?

pAcl - The ACL

pSecurityConfiguration - The security configuration

Returns:

a new MehtodSecurityConfiguration

Throws:

RestInitializationException

toString

public java.lang.String toString()

Overrides:

toString in class RestSecurityConfiguration