Package com.sun.identity.policy.remote

Class PolicyNotification

java.lang.Object

com.sun.identity.policy.remote.PolicyNotification

public class PolicyNotification
extends Object

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

 <!-- PolicyNotification element specifies a policy notification.
      The attribute notificationId is used for identifying the
      notification.
 -->

 <!ELEMENT    PolicyNotification    ( PolicyChangeNotification ) >
 <!ATTLIST    PolicyNotification
     notificationId        CDATA        #REQUIRED
 -->


 <!-- 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 ) >

 

Field Summary

Fields

Modifier and Type	Field	Description
static int	POLICY_CHANGE_TYPE

Method Summary

Modifier and Type	Method	Description
String	getNotificationId()	Returns the notification Id of this notification.
int	getNotificationType()	Returns the notification type of this notification.
PolicyChangeNotification	getPolicyChangeNotification()	Returns the notification Id of this notification.
static PolicyNotification	parseXML(Node pNode)	Returns a PolicyNotification object constructed from a XML.
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

Field Detail

POLICY_CHANGE_TYPE

public static final int POLICY_CHANGE_TYPE

See Also:

Constant Field Values

Method Detail

getNotificationType

public int getNotificationType()

Returns the notification type of this notification.

Returns:

notification type.

getNotificationId

public String getNotificationId()

Returns the notification Id of this notification.

Returns:

notification Id.

getPolicyChangeNotification

public PolicyChangeNotification getPolicyChangeNotification()

Returns the notification Id of this notification.

Returns:

notification Id.

parseXML

public static PolicyNotification parseXML(Node pNode)
                                   throws PolicyEvaluationException

Returns a PolicyNotification object constructed from a XML.

Parameters:

pNode - the XML DOM node for the PolicyNotification object.

Returns:

constructed PolicyNotification object.

Throws:

PolicyEvaluationException - if PolicyNotification object cannot be constructed.

toXMLString

public String toXMLString()

Returns a XML representation of this object.

Returns:

a XML representation of this object.