|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.verisign.epp.codec.gen.EPPDcp
public class EPPDcp
An Optional <dcp> (data collection policy) element that contains child elements used to describe the server's policy for data collection and management.Polcy elements should be discolsed to all entities directly and indirectly invloved in subsequent server interactions, Child elements include the following
getAccess
and setAccess
to get and set the Access
element(s), Use methods getStatement
and
setStatement
to get and set the Statement elements(s).
EPPFactory
,
EPPGreeting
,
EPPService
,
Serialized FormField Summary | |
---|---|
static short |
ACCESS_ALL
Constant used with the Access attribute that means access is given to all identified data. |
static short |
ACCESS_NONE
Constant used with the Access attribute that means No access is provided to identified data. |
static short |
ACCESS_NULL
Constant used with the Access attribute that means data is not persistent, so no access is possible. |
static short |
ACCESS_OTHER
Constant used with the Access attribute that means access is given to other identified data of a non- personal nature. |
static short |
ACCESS_PERSONAL
Constant used with the Access attribute that means access is given to identified data relating to individuals and organizational entities. |
static short |
ACCESS_PERSONAL_AND_OTHER
Constant used with the Access attribute that means access is given to identified data relating to individuals, organizational entities, and other data of a non-personal nature. |
static short |
EXPIRY_ABSOLUTE
Constant used with the Expiry attribute that means the policy is valid from the current date and time until it expires on the specified date and time. |
static short |
EXPIRY_NONE
No expiry specified. |
static short |
EXPIRY_RELATIVE
Constant used with the Expiry attribute that means the policy is valid from the current date and time until the end of the specified duration. |
Constructor Summary | |
---|---|
EPPDcp()
Default constructor. |
|
EPPDcp(short aAccess,
java.util.Vector aStatements)
Allocates a new EPPDcp and sets all of the required
attributes to the arguments values. |
|
EPPDcp(short aAccess,
java.util.Vector aStatements,
java.util.Date aExpiryAbsolute)
Allocates a new EPPDcp and sets all of the required
attributes and an absolute expiry. |
|
EPPDcp(short aAccess,
java.util.Vector aStatements,
Duration aExpiryRelative)
Allocates a new EPPDcp and sets all of the required
attributes and a relative expiry duration. |
Method Summary | |
---|---|
void |
addStatement(EPPStatement aStatement)
Adds a supported/desired Statement object. |
java.lang.Object |
clone()
Clone EPPDcp . |
void |
decode(org.w3c.dom.Element aElement)
decode EPPDcp from a DOM element tree. |
org.w3c.dom.Element |
encode(org.w3c.dom.Document aDocument)
encode EPPDcp into a DOM element tree. |
boolean |
equals(java.lang.Object aObject)
implements a deep EPPDcp compare. |
short |
getAccess()
|
java.util.Date |
getExpiryAbsolute()
Gets the expiry absolute date. |
short |
getExpiryType()
Gets the expiry type by returning one of the EXPIRY_
constants. |
Duration |
getExpiryyRelative()
Gets the expiry relative duration. |
java.util.Vector |
getStatements()
|
void |
setAccess(short aAccess)
Sets the Access service associated with the DataCollectionPolciy Objecat |
void |
setExpiryAbsolute(java.util.Date aExpiryDate)
Sets the expiry to an absolute date. |
void |
setExpiryRelative(Duration aDuration)
Sets the expiry to an relative duration. |
void |
setStatements(java.util.Vector aStatements)
Sets the list of supported/desired Statement objects. |
java.lang.String |
toString()
Implementation of Object.toString , which will result in an
indented XML String representation of the concrete
EPPCodecComponent . |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final short EXPIRY_NONE
public static final short EXPIRY_ABSOLUTE
public static final short EXPIRY_RELATIVE
public static final short ACCESS_ALL
public static final short ACCESS_NONE
public static final short ACCESS_NULL
public static final short ACCESS_PERSONAL
public static final short ACCESS_PERSONAL_AND_OTHER
public static final short ACCESS_OTHER
Constructor Detail |
---|
public EPPDcp()
public EPPDcp(short aAccess, java.util.Vector aStatements)
EPPDcp
and sets all of the required
attributes to the arguments values. The expiry is set to
EXPIRY_NONE
.
aAccess
- Using one of the ACCESS_
constantsaStatements
- vector of EPPStatement
instancespublic EPPDcp(short aAccess, java.util.Vector aStatements, java.util.Date aExpiryAbsolute)
EPPDcp
and sets all of the required
attributes and an absolute expiry.
aAccess
- Using one of the ACCESS_
constantsaStatements
- vector of EPPStatement
instancesaExpiryAbsolute
- Absolute expiry datepublic EPPDcp(short aAccess, java.util.Vector aStatements, Duration aExpiryRelative)
EPPDcp
and sets all of the required
attributes and a relative expiry duration.
aAccess
- Using one of the ACCESS_
constantsaStatements
- vector of EPPStatement
instancesaExpiryRelative
- Relative expiry durationMethod Detail |
---|
public java.util.Vector getStatements()
public void setStatements(java.util.Vector aStatements)
aStatements
- Vector of EPPStatement
instances.public void addStatement(EPPStatement aStatement)
aStatement
- Statements to addpublic short getAccess()
public void setAccess(short aAccess)
aAccess
- Describes access provided by the serverpublic java.util.Date getExpiryAbsolute()
null
otherwise.public void setExpiryAbsolute(java.util.Date aExpiryDate)
null
since they are mutually
exclusive.
aExpiryDate
- Date when DCP expirespublic Duration getExpiryyRelative()
null
otherwise.public void setExpiryRelative(Duration aDuration)
null
since they are mutually
exclusive.
aDuration
- Duration that the DCP is validpublic short getExpiryType()
EXPIRY_
constants. Use the appropriate getExpiry
method based on
the type.
EXPIRY_
constant value.public org.w3c.dom.Element encode(org.w3c.dom.Document aDocument) throws EPPEncodeException
EPPDcp
into a DOM element tree. The "dcp" element
is created and the access
,statement
nodes are
appended as children.
encode
in interface EPPCodecComponent
aDocument
- DOCUMENT ME!
EPPEncodeException
- Error encoding the DOM element tree.public void decode(org.w3c.dom.Element aElement) throws EPPDecodeException
EPPDcp
from a DOM element tree. The
aElement
argument needs to be the <dcp> element
decode
in interface EPPCodecComponent
aElement
- root element tree.
EPPDecodeException
- Error decoding the DOM element tree.public boolean equals(java.lang.Object aObject)
EPPDcp
compare.
equals
in class java.lang.Object
aObject
- EPPDcp
instance to compare with
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
EPPDcp
.
clone
in interface EPPCodecComponent
clone
in class java.lang.Object
EPPDcp
java.lang.CloneNotSupportedException
- standard Object.clone exceptionpublic java.lang.String toString()
Object.toString
, which will result in an
indented XML String
representation of the concrete
EPPCodecComponent
.
toString
in class java.lang.Object
String
if successful;
ERROR
otherwise.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |