Package com.sun.identity.policy.remote

Class PolicyChangeNotification

java.lang.Object

com.sun.identity.policy.remote.PolicyChangeNotification

public class PolicyChangeNotification
extends Object

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

 <!-- PolicyNotification element specifies a policy notification.
      There are two types of notifications that are supported.
      Policy Change Notification and Subject Change Notification.
 -->

 <!ELEMENT    PolicyNotification    ( PolicyChangeNotification
                                     | SubjectChangeNotification ) >


 <!-- PolicyChangeNotification element sends a notification to the
      client if a policy regarding the service has been changed.
      The attribute serviceName specifies the service name.
      The attribute type specifies the policy change type.
      The sub-element ResourceName specifies the name of the resource
      which is affected by the policy change.
 -->

 <!ELEMENT    PolicyChangeNotification    ( ResourceName* ) >
 <!ATTLIST    PolicyChangeNotification
     serviceName    NMTOKEN    #REQUIRED
     type           (added | modified | deleted)  "modified"
 >


 <!-- ResourceName element respresents a resource name
 -->

 <!ELEMENT    ResourceName    ( #PCDATA ) >
 
 

Method Summary

Modifier and Type	Method	Description
String	getPolicyChangeType()	Returns the policy change type.
Set	getResourceNames()	Returns the resource names.
String	getServiceName()	Returns the service name to which this notification is sent.
static PolicyChangeNotification	parseXML(Node pNode)	Returns PolicyChangeNotification object constructed from the XML.
void	setPolicyChangeType(String type)	Sets the policy change type.
void	setServiceName(String sn)	Sets the service name to which this notification is sent.
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

Method Detail

getServiceName

public String getServiceName()

Returns the service name to which this notification is sent.

Returns:

service name

setServiceName

public void setServiceName(String sn)

Sets the service name to which this notification is sent.

Parameters:

sn - Service name.

getPolicyChangeType

public String getPolicyChangeType()

Returns the policy change type.

Returns:

the policy change type.

setPolicyChangeType

public void setPolicyChangeType(String type)

Sets the policy change type.

Parameters:

type - Policy change type.

getResourceNames

public Set getResourceNames()

Returns the resource names.

Returns:

resource names.

parseXML

public static PolicyChangeNotification parseXML(Node pNode)
                                         throws PolicyEvaluationException

Returns PolicyChangeNotification object constructed from the XML.

Parameters:

pNode - the XML DOM node for the PolicyChangeNotification object.

Returns:

constructed PolicyChangeNotification object.

Throws:

PolicyEvaluationException

toXMLString

public String toXMLString()

Returns a XML representation of this object.

Returns:

a XML representation of this object.