public class EPPLoginSecPolicyEvent extends java.lang.Object implements EPPCodecComponent
Modifier and Type | Class and Description |
---|---|
static class |
EPPLoginSecPolicyEvent.EventErrorAction
Possible list of event error action types.
|
static class |
EPPLoginSecPolicyEvent.EventLevel
Possible list of security event levels.
|
static class |
EPPLoginSecPolicyEvent.EventType
Possible list of security event types.
|
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
ELM_LOCALNAME
XML local name for
EPPLoginSecPolicyEvent . |
static java.lang.String |
ELM_NAME
XML root tag for
EPPLoginSecPolicyEvent . |
Constructor and Description |
---|
EPPLoginSecPolicyEvent()
EPPLoginSecPolicyEvent default constructor. |
EPPLoginSecPolicyEvent(EPPLoginSecPolicyEvent.EventType aType,
EPPLoginSecPolicyEvent.EventLevel aLevel)
EPPLoginSecPolicyEvent constructor that takes the required type
and an single level attributes. |
EPPLoginSecPolicyEvent(EPPLoginSecPolicyEvent.EventType aType,
java.util.List<EPPLoginSecPolicyEvent.EventLevel> aLevels)
EPPLoginSecPolicyEvent constructor that takes the required type
and levels attributes. |
EPPLoginSecPolicyEvent(EPPLoginSecPolicyEvent.EventType aType,
java.util.List<EPPLoginSecPolicyEvent.EventLevel> aLevels,
java.lang.String aName,
java.lang.Boolean aExDate,
java.lang.String aExPeriod,
java.lang.String aWarningPeriod,
EPPLoginSecPolicyEvent.EventErrorAction aErrorAction,
java.lang.Integer aThreshold,
java.lang.String aPeriod)
EPPLoginSecPolicyEvent constructor that takes all attributes. |
Modifier and Type | Method and Description |
---|---|
void |
addLevel(EPPLoginSecPolicyEvent.EventLevel aLevel)
Add a level to the list of levels.
|
java.lang.Object |
clone()
Clone
EPPLoginSecPolicyEvent instance. |
void |
decode(org.w3c.dom.Element aElement)
Decode the
EPPLoginSecPolicyEvent element aElement DOM Element
tree. |
org.w3c.dom.Element |
encode(org.w3c.dom.Document aDocument)
Encode a DOM Element tree from the attributes of the
EPPLoginSecPolicyEvent instance. |
boolean |
equals(java.lang.Object aObject)
implements a deep
EPPLoginSecPolicyEvent compare. |
EPPLoginSecPolicyEvent.EventErrorAction |
getErrorAction()
Gets the error action.
|
java.lang.Boolean |
getExDate()
Gets the OPTIONAL boolean element that indicates whether the event type
includes a <loginSec:exDate> element with the default value of
false . |
java.lang.String |
getExPeriod()
Gets the OPTIONAL expiry period value, which identifies the duration that
the event type must be set using the XML schema "duration" type.
|
java.util.List<EPPLoginSecPolicyEvent.EventLevel> |
getLevels()
Gets the level list.
|
java.lang.String |
getName()
Gets the OPTIONAL event name value.
|
java.lang.String |
getNamespace()
Returns the XML namespace associated with the
EPPCodecComponent . |
java.lang.String |
getPeriod()
Gets the OPTIONAL period value, which indicates the period value that is
associated with a warning event for a specific "stat" event.
|
java.lang.Integer |
getThreshold()
Gets the OPTIONAL threshold value that triggers a warning event for a
specific "stat" event.
|
EPPLoginSecPolicyEvent.EventType |
getType()
Gets the event type value.
|
java.lang.String |
getWarningPeriod()
Gets the OPTIONAL warning period value, which indicates how long prior to
expiry the server will include a warning event using the XML schema
"duration" type.
|
boolean |
hasErrorAction()
Is the error action defined?
|
boolean |
hasExPeriod()
Is the expiry period defined?
|
boolean |
hasLevels()
Is the level list defined?
|
boolean |
hasName()
Is the name defined?
|
boolean |
hasPeriod()
Is the period defined?
|
boolean |
hasThreshold()
Is the threshold defined?
|
boolean |
hasType()
Is the type defined?
|
boolean |
hasWarningPeriod()
Is the warning period defined?
|
void |
setErrorAction(EPPLoginSecPolicyEvent.EventErrorAction aErrorAction)
Sets the error action.
|
void |
setExDate(java.lang.Boolean aExDate)
Sets the OPTIONAL boolean element that indicates whether the event type
includes a <loginSec:exDate> element with the default value of
false . |
void |
setExPeriod(java.lang.String aExPeriod)
Sets the OPTIONAL expiry period value, which identifies the duration that
the event type must be set using the XML schema "duration" type.
|
void |
setLevels(java.util.List<EPPLoginSecPolicyEvent.EventLevel> aLevels)
Sets the level list.
|
void |
setName(java.lang.String aName)
Sets the OPTIONAL event name value.
|
void |
setPeriod(java.lang.String aPeriod)
Sets the OPTIONAL period value, which indicates the period value that is
associated with a warning event for a specific "stat" event.
|
void |
setThreshold(java.lang.Integer aThreshold)
Sets the OPTIONAL threshold value that triggers a warning event for a
specific "stat" event.
|
void |
setType(EPPLoginSecPolicyEvent.EventType aType)
Sets the event type value.
|
void |
setWarningPeriod(java.lang.String aWarningPeriod)
Sets the OPTIONAL warning period value, which indicates how long prior to
expiry the server will include a warning event using the XML schema
"duration" type.
|
java.lang.String |
toString()
Implementation of
Object.toString , which will result in an
indented XML String representation of the concrete
EPPCodecComponent . |
void |
validateState()
Validate the state of the
EPPLoginSecPolicyEvent instance. |
public static final java.lang.String ELM_LOCALNAME
EPPLoginSecPolicyEvent
.public static final java.lang.String ELM_NAME
EPPLoginSecPolicyEvent
.public EPPLoginSecPolicyEvent()
EPPLoginSecPolicyEvent
default constructor. At least one level
must be defined period to calling encode(Document)
.public EPPLoginSecPolicyEvent(EPPLoginSecPolicyEvent.EventType aType, EPPLoginSecPolicyEvent.EventLevel aLevel)
EPPLoginSecPolicyEvent
constructor that takes the required type
and an single level attributes.aType
- Event typeaLevel
- Single event level the server will returnpublic EPPLoginSecPolicyEvent(EPPLoginSecPolicyEvent.EventType aType, java.util.List<EPPLoginSecPolicyEvent.EventLevel> aLevels)
EPPLoginSecPolicyEvent
constructor that takes the required type
and levels attributes.aType
- Event typeaLevels
- Possible set of event levels the server will returnpublic EPPLoginSecPolicyEvent(EPPLoginSecPolicyEvent.EventType aType, java.util.List<EPPLoginSecPolicyEvent.EventLevel> aLevels, java.lang.String aName, java.lang.Boolean aExDate, java.lang.String aExPeriod, java.lang.String aWarningPeriod, EPPLoginSecPolicyEvent.EventErrorAction aErrorAction, java.lang.Integer aThreshold, java.lang.String aPeriod)
EPPLoginSecPolicyEvent
constructor that takes all attributes.aType
- Event typeaLevels
- Possible set of event levels the server will returnaName
- OPTIONAL custom event type or specific statistical event. Set to
null
if undefined.aExDate
- OPTIONAL boolean element that indicates whether the event type
includes a <loginSec:exDate> element with a default value
of false
. Set to null
will set the default.aExPeriod
- OPTIONAL duration element that the event type must be reset. Set
to null
if undefined.aWarningPeriod
- OPTIONAL duration element that indicates how long prior to
expiry the server will include a warning event. Set to
null
if undefined.aErrorAction
- OPTIONAL indication of what action will occur with an error Set
to null
if undefined.aThreshold
- OPTIONAL threshold value that triggers a warning event for a
specific "stat" event. Set to null
if undefined.aPeriod
- OPTIONAL period value that is associated with a warning event
for a specific "stat" event. Set to null
if undefined.public java.lang.Object clone() throws java.lang.CloneNotSupportedException
EPPLoginSecPolicyEvent
instance.clone
in interface EPPCodecComponent
clone
in class java.lang.Object
EPPLoginSecPolicyEvent
java.lang.CloneNotSupportedException
- standard Object.clone exceptionpublic void validateState() throws EPPCodecException
EPPLoginSecPolicyEvent
instance. A valid
state means that all of the required attributes have been set. If
validateState returns without an exception, the state is valid. If the
state is not valid, the EPPCodecException
will contain a
description of the error. throws EPPCodecException State error. This will
contain the name of the attribute that is not valid.EPPCodecException
- On invalid statepublic org.w3c.dom.Element encode(org.w3c.dom.Document aDocument) throws EPPEncodeException
EPPLoginSecPolicyEvent
instance.encode
in interface EPPCodecComponent
aDocument
- - DOM Document that is being built. Used as an Element factory.EPPLoginSecPolicyEvent
instance.EPPEncodeException
- - Unable to encode EPPLoginSecPolicyEvent
instance.public void decode(org.w3c.dom.Element aElement) throws EPPDecodeException
EPPLoginSecPolicyEvent
element aElement DOM Element
tree.decode
in interface EPPCodecComponent
aElement
- - Root DOM Element to decode EPPLoginSecPolicyEvent
from.EPPDecodeException
- Unable to decode aElementpublic boolean equals(java.lang.Object aObject)
EPPLoginSecPolicyEvent
compare.equals
in class java.lang.Object
aObject
- EPPLoginSecPolicyEvent
instance to compare withtrue
if equal; false
otherwisepublic 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.public java.lang.String getNamespace()
EPPCodecComponent
.getNamespace
in interface EPPCodecComponent
EPPCodecComponent
.public boolean hasType()
true
if the type is defined; false
otherwise.public EPPLoginSecPolicyEvent.EventType getType()
EPPLoginSecPolicyEvent.EventType
enumerated value if set; null
otherwise.public void setType(EPPLoginSecPolicyEvent.EventType aType)
aType
- Sets the event type value.public boolean hasName()
true
if the name is defined; false
otherwise.public java.lang.String getName()
null
otherwise.public void setName(java.lang.String aName)
aName
- Event type name. Set to null
if undefined.public boolean hasLevels()
true
if the level list is defined; false
otherwise.public java.util.List<EPPLoginSecPolicyEvent.EventLevel> getLevels()
public void setLevels(java.util.List<EPPLoginSecPolicyEvent.EventLevel> aLevels)
aLevels
- List of levels.public void addLevel(EPPLoginSecPolicyEvent.EventLevel aLevel)
aLevel
- Level to add to the list of levels.public java.lang.Boolean getExDate()
false
.true
or false
indicating whether the event type
includes a <loginSec:exDate> element.public void setExDate(java.lang.Boolean aExDate)
false
.aExDate
- true
or false
indicating whether the server
event type includes a <loginSec:exDate> element. If
null
is passed, the default value of false
will
be set.public boolean hasExPeriod()
true
if the expiry period is defined; false
otherwise.public java.lang.String getExPeriod()
null
otherwise.public void setExPeriod(java.lang.String aExPeriod)
aExPeriod
- Expiry period using the XML schema "duration" type. Set to
null
if undefined.public boolean hasWarningPeriod()
true
if the warning period is defined; false
otherwise.public java.lang.String getWarningPeriod()
null
otherwise.public void setWarningPeriod(java.lang.String aWarningPeriod)
aWarningPeriod
- Warning period using the XML schema "duration" type. Set to
null
if undefined.public boolean hasErrorAction()
true
if the error action is defined; false
otherwise.public EPPLoginSecPolicyEvent.EventErrorAction getErrorAction()
null
otherwise.public void setErrorAction(EPPLoginSecPolicyEvent.EventErrorAction aErrorAction)
aErrorAction
- Action that will occur with an error. Set to null
if
undefined.public boolean hasThreshold()
true
if the threshold is defined; false
otherwise.public java.lang.Integer getThreshold()
null
otherwise.public void setThreshold(java.lang.Integer aThreshold)
aThreshold
- Threshold value that triggers a warning event for a specific
"stat" event. Set to null
if undefined.public boolean hasPeriod()
true
if the period is defined; false
otherwise.public java.lang.String getPeriod()
null
otherwise.public void setPeriod(java.lang.String aPeriod)
aPeriod
- Period value, which indicates the period value that is
associated with a warning event for a specific "stat" event.
using the XML schema "duration" type. Set to null
if
undefined.