com.neulevel.epp.core
Class EppDataCollectionPolicy

java.lang.Object
  com.neulevel.epp.core.EppEntity
      com.neulevel.epp.core.EppDataCollectionPolicy

public class EppDataCollectionPolicy
extends EppEntity

This EppDataCollectionPolicy class implements EPP Data Collection Policy (DCP) entity.

An EPP Data Collection Policy object describes the server's privacy policy for data collection and management. Policy implications usually extend beyond the client-server relationship. Both clients and servers can have relationships with other entities that need to know the server operator's data collection policy to make informed provisioning decisions. Policy information must be disclosed to provisioning entities, though the method of disclosing policy data outside of direct protocol interaction is beyond the scope of the EPP specification.

An EPP Data Collection Policy object contains 3 components:

• Description of the access provided by the server to the client on behalf of the originating data source.
• Description of data collection purposes, data recipients, and data retention practices
• Description of the lifetime of the data collection policy (optional).

Version:

$Revision: 1.2 $ $Date: 2006/03/01 01:35:38 $

Author:

Ning Zhang ning.zhang@neustar.com

Field Summary

static java.lang.String	ACCESS_ALL DCP Access Type - all
static java.lang.String	ACCESS_NONE DCP Access Type - none:
static java.lang.String	ACCESS_NULL DCP Access Type - null
static java.lang.String	ACCESS_OTHER DCP Access Type - other
static java.lang.String	ACCESS_PERSONAL DCP Access Type - personal
static java.lang.String	ACCESS_PERSONAL_AND_OTHER DCP Access Type - personalAndOther

Constructor Summary

EppDataCollectionPolicy()
Creates an EppDataCollectionPolicy object

Method Summary

void	addStatement(EppDataCollectionStatement stmt) Adds a data collection statement
static EppEntity	fromXML(org.w3c.dom.Node root) Converts an XML element into an EppDataCollectionPolicy object.
java.lang.String	getAccess() Gets data access policy
java.util.Calendar	getExpiryAbsolute() Gets the absolute policy expiry timestamp
java.lang.String	getExpiryRelative() Gets the relative policy expiry timestamp
java.util.Vector	getStatement() Gets the list of data collection statements
void	setAccess(java.lang.String type) Sets data access policy, with one of the following values ACCESS_ALL ACCESS_NONE ACCESS_NULL ACCESS_PERSONAL ACCESS_PERSONAL_AND_OTHER ACCESS_OTHER
void	setExpiry(java.util.Calendar timestamp) Sets the absolute policy expiry timestamp
void	setExpiry(java.lang.String duration) Sets the relative policy expiry duration.
void	setStatement(java.util.Vector list) Sets the list of data collection statements
java.lang.String	toString()
org.w3c.dom.Element	toXML(org.w3c.dom.Document doc, java.lang.String tag) Converts the EppDataCollectionPolicy object into an XML element

Methods inherited from class com.neulevel.epp.core.EppEntity

toString

Methods inherited from class java.lang.Object

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

Field Detail

ACCESS_ALL

public static final java.lang.String ACCESS_ALL

DCP Access Type - all

Access is given to all identified data.

See Also:

Constant Field Values

ACCESS_NONE

public static final java.lang.String ACCESS_NONE

DCP Access Type - none:

No access is provided to identified data.

See Also:

Constant Field Values

ACCESS_NULL

public static final java.lang.String ACCESS_NULL

DCP Access Type - null

Data is not persistent, so no access is possible.

See Also:

Constant Field Values

ACCESS_PERSONAL

public static final java.lang.String ACCESS_PERSONAL

DCP Access Type - personal

Access is given to identified data relating to individuals and organizational entities.

See Also:

Constant Field Values

ACCESS_PERSONAL_AND_OTHER

public static final java.lang.String ACCESS_PERSONAL_AND_OTHER

DCP Access Type - personalAndOther

Access is given to identified data relating to individuals, organizational entities, and other data of a non-personal nature.

See Also:

Constant Field Values

ACCESS_OTHER

public static final java.lang.String ACCESS_OTHER

DCP Access Type - other

Access is given to other identified data of a non-personal nature.

See Also:

Constant Field Values

Constructor Detail

EppDataCollectionPolicy

public EppDataCollectionPolicy()

Creates an EppDataCollectionPolicy object

Method Detail

getAccess

public java.lang.String getAccess()

Gets data access policy

setAccess

public void setAccess(java.lang.String type)

Sets data access policy, with one of the following values

• ACCESS_ALL
• ACCESS_NONE
• ACCESS_NULL
• ACCESS_PERSONAL
• ACCESS_PERSONAL_AND_OTHER
• ACCESS_OTHER

getStatement

public java.util.Vector getStatement()

Gets the list of data collection statements

setStatement

public void setStatement(java.util.Vector list)

Sets the list of data collection statements

addStatement

public void addStatement(EppDataCollectionStatement stmt)

Adds a data collection statement

getExpiryAbsolute

public java.util.Calendar getExpiryAbsolute()

Gets the absolute policy expiry timestamp

getExpiryRelative

public java.lang.String getExpiryRelative()

Gets the relative policy expiry timestamp

setExpiry

public void setExpiry(java.util.Calendar timestamp)

Sets the absolute policy expiry timestamp

setExpiry

public void setExpiry(java.lang.String duration)

Sets the relative policy expiry duration.

Please refer XML Schema Part 2: Datatypes for the exact definition and format of the XML duration data type.

FIXME(ning.zhang@neustar,com) - duration needs to be defined as javax.xml.datatype.Duration in JDK 1.5.

toXML

public org.w3c.dom.Element toXML(org.w3c.dom.Document doc,
                                 java.lang.String tag)

Converts the EppDataCollectionPolicy object into an XML element

Specified by:

toXML in class EppEntity

Parameters:

doc - the XML Document object

tag - the tag/element name for the EppDataCollectionPolicy object

Returns:

an Element object

fromXML

public static EppEntity fromXML(org.w3c.dom.Node root)

Converts an XML element into an EppDataCollectionPolicy object. The caller of this method must make sure that the root node is of the EPP Data Collection Statment.type.

Parameters:

root - root node for an EppDataCollectionPolicy object in XML format

Returns:

an EppDataCollectionPolicy object, or null if the node is invalid

toString

public java.lang.String toString()

Specified by:

toString in class EppEntity