com.sun.identity.liberty.ws.security

Class ResourceAccessStatement

java.lang.Object

com.sun.identity.saml.assertion.Statement

com.sun.identity.saml.assertion.SubjectStatement

com.sun.identity.liberty.ws.security.ResourceAccessStatement

public class ResourceAccessStatement
extends SubjectStatement

The ResourceAccessStatement class conveys information regarding the accessing entities and the resource for which access is being attempted.

Constructor Summary

Constructors

Constructor and Description
ResourceAccessStatement(Element element) Constructs an ResourceAccessStatement object from a DOM Element.
ResourceAccessStatement(EncryptedResourceID encryptedResourceID, ProxySubject proxySubject, SessionContext sessionContext, Subject subject) Constructs a ResourceAccessStatement object from a EncryptedResourceID object, ProxySubject object, a SessionContext object and a Subject.
ResourceAccessStatement(ResourceID resourceID, ProxySubject proxySubject, SessionContext sessionContext, Subject subject) Constructs a ResourceAccessStatement object from a ResourceID object, ProxySubject object, a SessionContext object and a Subject.
ResourceAccessStatement(String resourceID, ProxySubject proxySubject, SessionContext sessionContext, Subject subject) Constructs a ResourceAccessStatement object from a String object, ProxySubject object, a SessionContext object and a Subject.
ResourceAccessStatement(String resourceID, ProxySubject proxySubject, Subject subject) Constructs a ResourceAccessStatement object from a String object, ProxySubject object and a Subject.
ResourceAccessStatement(String resourceID, Subject subject) Constructs a ResourceAccessStatement object from a String object and a Subject.

Method Summary

Modifier and Type	Method and Description
EncryptedResourceID	getEncryptedResourceID() Gets the EncryptedResourceID object from this ResourceAccessStatement object.
ProxySubject	getProxySubject() Returns the ProxySubject in the ResourceAccessStatement.
String	getResourceID() Gets the ResourceID from this ResourceAccessStatement object.
ResourceID	getResourceIDObject() Gets the ResourceID object from this ResourceAccessStatement object.
SessionContext	getSessionContext() Gets the SessionContext from this ResourceAccessStatement object.
int	getStatementType() Returns the type of the Statement.
void	setEncryptedResourceID(EncryptedResourceID resourceID) Sets the EncryptedResourceID for this ResourceAccessStatement object.
void	setResourceID(ResourceID resourceID) Sets the ResourceID for this ResourceAccessStatement object.
boolean	setResourceID(String resourceID) Sets the ResourceID for this ResourceAccessStatement object.
boolean	setSessionContext(SessionContext sessionContext) Sets the SessionContext for this ResourceAccessStatement object.
String	toString() Returns a String representation of the ResourceAccessStatement.
String	toString(boolean includeNS, boolean declareNS) Returns a String representation of the ResourceAccessStatement.

Methods inherited from class com.sun.identity.saml.assertion.SubjectStatement

getSubject, setSubject

Methods inherited from class java.lang.Object

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

Constructor Detail

ResourceAccessStatement

public ResourceAccessStatement(Element element)
                        throws SAMLException

Constructs an ResourceAccessStatement object from a DOM Element.

Parameters:

element - representing a DOM tree element

Throws:

SAMLException - if there is an error in the sender or in the element definition.

ResourceAccessStatement

public ResourceAccessStatement(String resourceID,
                               Subject subject)
                        throws SAMLException

Constructs a ResourceAccessStatement object from a String object and a Subject.

Parameters:

resourceID - String.

subject - Subject object.

Throws:

SAMLException - if subject is null.

ResourceAccessStatement

public ResourceAccessStatement(String resourceID,
                               ProxySubject proxySubject,
                               Subject subject)
                        throws SAMLException

Constructs a ResourceAccessStatement object from a String object, ProxySubject object and a Subject.

Parameters:

resourceID - String.

proxySubject - ProxySubject object.

subject - Subject object.

Throws:

SAMLException - if subject is null.

ResourceAccessStatement

public ResourceAccessStatement(String resourceID,
                               ProxySubject proxySubject,
                               SessionContext sessionContext,
                               Subject subject)
                        throws SAMLException

Constructs a ResourceAccessStatement object from a String object, ProxySubject object, a SessionContext object and a Subject.

Parameters:

resourceID - resource ID.

proxySubject - ProxySubject object.

sessionContext - SessionContext object.

subject - Subject object.

Throws:

SAMLException - if subject is null.

ResourceAccessStatement

public ResourceAccessStatement(ResourceID resourceID,
                               ProxySubject proxySubject,
                               SessionContext sessionContext,
                               Subject subject)
                        throws SAMLException

Constructs a ResourceAccessStatement object from a ResourceID object, ProxySubject object, a SessionContext object and a Subject.

Parameters:

resourceID - resource ID.

proxySubject - ProxySubject object.

sessionContext - SessionContext object.

subject - Subject object.

Throws:

SAMLException - if subject is null.

ResourceAccessStatement

public ResourceAccessStatement(EncryptedResourceID encryptedResourceID,
                               ProxySubject proxySubject,
                               SessionContext sessionContext,
                               Subject subject)
                        throws SAMLException

Constructs a ResourceAccessStatement object from a EncryptedResourceID object, ProxySubject object, a SessionContext object and a Subject.

Parameters:

encryptedResourceID - the encrypted resource ID.

proxySubject - ProxySubject object.

sessionContext - SessionContext object.

subject - Subject object.

Throws:

SAMLException - if subject is null.

Method Detail

getResourceID

public String getResourceID()

Gets the ResourceID from this ResourceAccessStatement object.

Returns:

resource ID

getResourceIDObject

public ResourceID getResourceIDObject()

Gets the ResourceID object from this ResourceAccessStatement object.

Returns:

resource ID

getEncryptedResourceID

public EncryptedResourceID getEncryptedResourceID()

Gets the EncryptedResourceID object from this ResourceAccessStatement object.

Returns:

encrypted resource ID

setResourceID

public boolean setResourceID(String resourceID)

Sets the ResourceID for this ResourceAccessStatement object.

Parameters:

resourceID - Resource ID.

Returns:

true if the operation is successful. Otherwise return false.

setResourceID

public void setResourceID(ResourceID resourceID)

Sets the ResourceID for this ResourceAccessStatement object.

Parameters:

resourceID - Resource ID.

setEncryptedResourceID

public void setEncryptedResourceID(EncryptedResourceID resourceID)

Sets the EncryptedResourceID for this ResourceAccessStatement object.

Parameters:

resourceID - encrypted Resource ID.

getStatementType

public int getStatementType()

Returns the type of the Statement.

Specified by:

getStatementType in class Statement

Returns:

An integer which represents ResourceAccessStatement internally.

setSessionContext

public boolean setSessionContext(SessionContext sessionContext)

Sets the SessionContext for this ResourceAccessStatement object.

Parameters:

sessionContext - Session context object

Returns:

true if the operation is successful. Otherwise return false.

getSessionContext

public SessionContext getSessionContext()

Gets the SessionContext from this ResourceAccessStatement object.

Returns:

SessionContext.

getProxySubject

public ProxySubject getProxySubject()

Returns the ProxySubject in the ResourceAccessStatement.

Returns:

ProxySubject.

toString

public String toString()

Returns a String representation of the ResourceAccessStatement.

Overrides:

toString in class Object

Returns:

A String representation of the ResourceAccessStatement element.

toString

public String toString(boolean includeNS,
                       boolean declareNS)

Returns a String representation of the ResourceAccessStatement.

Specified by:

toString in class SubjectStatement

Parameters:

includeNS - Determines whether or not the namespace qualifier is prepended to the Element when converted.

declareNS - Determines whether or not the namespace is declared within the Element.

Returns:

A string representation of the ResourceAccessStatement element.