Package com.sun.identity.policy.remote

Class ResourceResultRequest

java.lang.Object

com.sun.identity.policy.remote.ResourceResultRequest

public class ResourceResultRequest
extends Object

This ResourceResultRequest class represents a GetResourceResults XML document. The GetResourceResults DTD is defined as the following:

 <!-- GetResourceResults element is used by the client to request
      the policy evaluation decisions for a particular user regarding
      a given service and a resource and possibly its sub resources.
      The attribute userSSOToken provides the identity of the user.
      The attribute serviceName specifies the service name and
      resourceName specifies the name of the resource for which the
      policy is evaluated.
      The attribute resourceScope gives the scope of the resources in
      terms of the policy evaluation. The value of the attribute could
      be "self", "strict-subtree", or "subtree". Value "self" means the
      resource node itself only; value "strict-subtree" means the strict
      subtree of the root, no wildcard matching subtree included; value
      "subtree" means to get all the subtrees with the resource node being
      the root of one of the subtree, the other subtree roots are those that
      match the resourceName by wildcard.
      The sub-element EnvParameters provides the environment
      information which may be useful during the policy evaluation.
      The sub-element GetResponseDecisions requests for the values for
      a set of user response attributes.
 -->

 <!ELEMENT    GetResourceResults   ( EnvParameters?, GetResponseDecisions? ) >
 <!ATTLIST    GetResourceResults
     userSSOToken    CDATA        #IMPLIED
     serviceName     NMTOKEN      #REQUIRED
     resourceName    CDATA        #REQUIRED
     resourceScope   (self | strict-subtree | subtree)  "strict-subtree"
 >
 

Constructor Summary

Constructors

Constructor	Description
ResourceResultRequest()	Default constructor for ResourceResultRequest.

Method Summary

Modifier and Type	Method	Description
Map	getEnvParms()	Returns the environment parameters.
String	getResourceName()	Returns the resource name of the request.
String	getResourceScope()	Returns the resource scope of the request.
Set	getResponseAttributes()	Returns the response attributes.
String	getServiceName()	Returns the service name of the request.
String	getUserSSOToken()	Returns the user's single sign-on token.
static ResourceResultRequest	parseXML(Node pNode)	Returns ResourceResultRequest object constructed from a XML.
void	setEnvParms(Map envs)	Sets the environment parameters.
void	setResourceName(String name)	Sets the resource name of the request.
void	setResourceScope(String scope)	Sets the resource scope of the request.
void	setResponseAttributes(Set attrs)	Sets the response attributes.
void	setServiceName(String name)	Sets the service name of the request.
void	setUserSSOToken(String ssoToken)	Sets the user's single sign-on token.
String	toXMLString()	Returns a XML representation of this object.

Methods inherited from class java.lang.Object

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

Constructor Detail

ResourceResultRequest

public ResourceResultRequest()

Default constructor for ResourceResultRequest.

Method Detail

getUserSSOToken

public String getUserSSOToken()

Returns the user's single sign-on token.

Returns:

user's single sign-on token.

setUserSSOToken

public void setUserSSOToken(String ssoToken)

Sets the user's single sign-on token.

Parameters:

ssoToken - user's single sign-on token.

getServiceName

public String getServiceName()

Returns the service name of the request.

Returns:

the service name.

setServiceName

public void setServiceName(String name)

Sets the service name of the request.

Parameters:

name - the service name.

getResourceName

public String getResourceName()

Returns the resource name of the request.

Returns:

the resource name.

setResourceName

public void setResourceName(String name)

Sets the resource name of the request.

Parameters:

name - Resource name.

getResourceScope

public String getResourceScope()

Returns the resource scope of the request.

Returns:

the resource scope.

setResourceScope

public void setResourceScope(String scope)

Sets the resource scope of the request.

Parameters:

scope - Resource scope.

getEnvParms

public Map getEnvParms()

Returns the environment parameters.

Returns:

the environment parameters.

setEnvParms

public void setEnvParms(Map envs)

Sets the environment parameters.

Parameters:

envs - the environment parameters.

getResponseAttributes

public Set getResponseAttributes()

Returns the response attributes.

Returns:

the response attributes.

setResponseAttributes

public void setResponseAttributes(Set attrs)

Sets the response attributes.

Parameters:

attrs - response attributes.

parseXML

public static ResourceResultRequest parseXML(Node pNode)
                                      throws PolicyEvaluationException

Returns ResourceResultRequest object constructed from a XML.

Parameters:

pNode - the XML DOM node for the ResourceResultRequest object

Returns:

constructed ResourceResultRequest object.

Throws:

PolicyEvaluationException

toXMLString

public String toXMLString()

Returns a XML representation of this object.

Returns:

a XML representation of this object.