Package com.sun.identity.policy.remote

Class PolicyService

java.lang.Object

com.sun.identity.policy.remote.PolicyService

public class PolicyService
extends Object

This PolicyService class repolicyResents a PolicyService XML document. The PolicyService DTD is defined as the following:

   <!-- PolicyService element is the root element for remote policy
    service. This XML will be typically used between the client
    and the server. The client uses the PolicyRequest element to
    request information from the server and the server would respond
    using the PolicyResponse element. The server would use
    PolicyNotification to send policy or subject change notification
    to the client.
   -->

   <!ELEMENT    PolicyService    ( PolicyRequest
                                   | PolicyResponse
                                   | PolicyNotification ) >
   <!ATTLIST    PolicyService
       version    CDATA    "1.0"
   >
 

Field Summary

Fields

Modifier and Type	Field	Description
static int	POLICY_NOTIFICATION_ID	Policy Notification ID.
static int	POLICY_REQUEST_ID	Policy Request ID.
static int	POLICY_RESPONSE_ID	Policy Response ID.
static String	POLICY_SERVICE	Policy Service name.

Constructor Summary

Constructors

Constructor	Description
PolicyService()	Default Constructor for PolicyService.

Method Summary

Modifier and Type	Method	Description
int	getMethodID()	Returns the method id of the Policy Service.
PolicyNotification	getPolicyNotification()	Returns the PolicyNotification object.
PolicyRequest	getPolicyRequest()	Returns the PolicyRequest object.
PolicyResponse	getPolicyResponse()	Returns the PolicyResponse object.
String	getRevision()	Returns the service revision number of the Policy Service.
String	getVersion()	Returns the version number of the Policy Service.
static PolicyService	parseXML(String xml)	Returns PolicyService object constructed from XML.
void	setMethodID(int id)	Sets the method id of the Policy Service.
void	setPolicyNotification(PolicyNotification noti)	Sets the PolicyNotification of the Policy Service.
void	setPolicyRequest(PolicyRequest req)	Sets the PolicyRequest of the Policy Service.
void	setPolicyResponse(PolicyResponse res)	Sets the PolicyResponse of the Policy Service.
void	setRevision(String revision)	Sets the service revision number for the Policy Service.
void	setVersion(String ver)	Sets the version for the Policy Service.
String	toXMLString()	Returns string representation of this object.

Methods inherited from class java.lang.Object

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

Field Detail

POLICY_SERVICE

public static final String POLICY_SERVICE

Policy Service name.

See Also:

Constant Field Values

POLICY_REQUEST_ID

public static final int POLICY_REQUEST_ID

Policy Request ID.

See Also:

Constant Field Values

POLICY_RESPONSE_ID

public static final int POLICY_RESPONSE_ID

Policy Response ID.

See Also:

Constant Field Values

POLICY_NOTIFICATION_ID

public static final int POLICY_NOTIFICATION_ID

Policy Notification ID.

See Also:

Constant Field Values

Constructor Detail

PolicyService

public PolicyService()

Default Constructor for PolicyService.

Method Detail

getRevision

public String getRevision()

Returns the service revision number of the Policy Service.

Returns:

the service revision number of the Policy Service.

setRevision

public void setRevision(String revision)

Sets the service revision number for the Policy Service.

Parameters:

revision - the revision

getVersion

public String getVersion()

Returns the version number of the Policy Service.

Returns:

the version of the Policy Service.

setVersion

public void setVersion(String ver)

Sets the version for the Policy Service.

Parameters:

ver - the version.

getMethodID

public int getMethodID()

Returns the method id of the Policy Service.

Returns:

the method id of the Policy Service.

setMethodID

public void setMethodID(int id)

Sets the method id of the Policy Service.

Parameters:

id - the method id of this Policy Service

getPolicyRequest

public PolicyRequest getPolicyRequest()

Returns the PolicyRequest object.

Returns:

the PolicyRequest object.

setPolicyRequest

public void setPolicyRequest(PolicyRequest req)

Sets the PolicyRequest of the Policy Service.

Parameters:

req - the PolicyRequest of this Policy Service

getPolicyResponse

public PolicyResponse getPolicyResponse()

Returns the PolicyResponse object.

Returns:

the PolicyResponse object.

setPolicyResponse

public void setPolicyResponse(PolicyResponse res)

Sets the PolicyResponse of the Policy Service.

Parameters:

res - the PolicyResponse of this Policy Service.

getPolicyNotification

public PolicyNotification getPolicyNotification()

Returns the PolicyNotification object.

Returns:

the PolicyNotification object

setPolicyNotification

public void setPolicyNotification(PolicyNotification noti)

Sets the PolicyNotification of the Policy Service.

Parameters:

noti - The PolicyNotification of this Policy Service.

parseXML

public static PolicyService parseXML(String xml)
                              throws PolicyEvaluationException

Returns PolicyService object constructed from XML.

Parameters:

xml - the XML document for the PolicyService object.

Returns:

constructed PolicyService object.

Throws:

PolicyEvaluationException

toXMLString

public String toXMLString()

Returns string representation of this object.

Returns:

string representation of this object.