org.openliberty.xmltooling.subs
Class Subscription

java.lang.Object
  org.opensaml.xml.AbstractXMLObject
      org.opensaml.xml.signature.AbstractSignableXMLObject
          org.openliberty.xmltooling.subs.Subscription

All Implemented Interfaces:

org.opensaml.xml.signature.SignableXMLObject, org.opensaml.xml.XMLObject

Direct Known Subclasses:

DAPSubscription

public class Subscription
extends org.opensaml.xml.signature.AbstractSignableXMLObject

The <Subscription> element contains all the parameters for a subscription. It defines what data a WSC wants to have, where it should be sent, when a subscription expires, which events should trigger notifications, etc.

Author:

asa

Nested Class Summary

static class	Subscription.IncludeDataEnum
static class	Subscription.SubscriptionBuilder Internal builder class simplifies the file structure

Field Summary

private java.lang.String	adminNotifyToRef
static java.lang.String	ATT_ADMIN_NOTIFY_TO_REF
static java.lang.String	ATT_EXPIRES
static java.lang.String	ATT_ID
static java.lang.String	ATT_INCLUDE_DATA
static java.lang.String	ATT_NOTIFY_TO_REF
static java.lang.String	ATT_STARTS
static java.lang.String	ATT_SUBSCRIPTION_ID
private org.joda.time.DateTime	expires
private org.opensaml.xml.util.XMLObjectChildrenList<Extension>	extensions
private java.lang.String	id
private Subscription.IncludeDataEnum	includeData
static java.lang.String	LOCAL_NAME
private java.lang.String	notifyToRef
private org.opensaml.xml.util.XMLObjectChildrenList<RefItem>	refItems
private org.joda.time.DateTime	starts
private java.lang.String	subscriptionID

Constructor Summary

protected

Subscription(java.lang.String namespaceURI, java.lang.String elementLocalName, java.lang.String namespacePrefix)

Method Summary

java.lang.String	getAdminNotifyToRef()
org.joda.time.DateTime	getExpires()
org.opensaml.xml.util.XMLObjectChildrenList<Extension>	getExtensions()
java.lang.String	getId()
Subscription.IncludeDataEnum	getIncludeData()
java.lang.String	getNotifyToRef()
java.util.List<org.opensaml.xml.XMLObject>	getOrderedChildren()
org.opensaml.xml.util.XMLObjectChildrenList<RefItem>	getRefItems()
org.joda.time.DateTime	getStarts()
java.lang.String	getSubscriptionID() A unique id for this WSC
void	setAdminNotifyToRef(java.lang.String adminNotifyToRef)
void	setExpires(org.joda.time.DateTime expires)
void	setId(java.lang.String id)
void	setIncludeData(Subscription.IncludeDataEnum includeData)
void	setNotifyToRef(java.lang.String notifyToRef)
void	setStarts(org.joda.time.DateTime starts)
void	setSubscriptionID(java.lang.String subscriptionID) The subscriptionID XML attribute MUST be unique within all subscriptions a WSC has at a WSP

Methods inherited from class org.opensaml.xml.signature.AbstractSignableXMLObject

getSignature, isSigned, setSignature

Methods inherited from class org.opensaml.xml.AbstractXMLObject

addNamespace, getDOM, getElementQName, getIDIndex, getNamespaces, getNoNamespaceSchemaLocation, getParent, getSchemaLocation, getSchemaType, hasChildren, hasParent, prepareForAssignment, prepareForAssignment, prepareForAssignment, prepareForAssignment, registerOwnID, releaseChildrenDOM, releaseDOM, releaseParentDOM, releaseThisAndChildrenDOM, releaseThisandParentDOM, removeNamespace, resolveID, resolveIDFromRoot, setDOM, setElementNamespacePrefix, setElementQName, setNoNamespaceSchemaLocation, setParent, setSchemaLocation, setSchemaType

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensaml.xml.XMLObject

addNamespace, getDOM, getElementQName, getIDIndex, getNamespaces, getNoNamespaceSchemaLocation, getParent, getSchemaLocation, getSchemaType, hasChildren, hasParent, releaseChildrenDOM, releaseDOM, releaseParentDOM, removeNamespace, resolveID, resolveIDFromRoot, setDOM, setNoNamespaceSchemaLocation, setParent, setSchemaLocation

Field Detail

LOCAL_NAME

public static java.lang.String LOCAL_NAME

subscriptionID

private java.lang.String subscriptionID

notifyToRef

private java.lang.String notifyToRef

adminNotifyToRef

private java.lang.String adminNotifyToRef

starts

private org.joda.time.DateTime starts

expires

private org.joda.time.DateTime expires

id

private java.lang.String id

includeData

private Subscription.IncludeDataEnum includeData

ATT_SUBSCRIPTION_ID

public static final java.lang.String ATT_SUBSCRIPTION_ID

See Also:

Constant Field Values

ATT_NOTIFY_TO_REF

public static final java.lang.String ATT_NOTIFY_TO_REF

See Also:

Constant Field Values

ATT_ADMIN_NOTIFY_TO_REF

public static final java.lang.String ATT_ADMIN_NOTIFY_TO_REF

See Also:

Constant Field Values

ATT_STARTS

public static final java.lang.String ATT_STARTS

See Also:

Constant Field Values

ATT_EXPIRES

public static final java.lang.String ATT_EXPIRES

See Also:

Constant Field Values

ATT_ID

public static final java.lang.String ATT_ID

See Also:

Constant Field Values

ATT_INCLUDE_DATA

public static final java.lang.String ATT_INCLUDE_DATA

See Also:

Constant Field Values

extensions

private org.opensaml.xml.util.XMLObjectChildrenList<Extension> extensions

refItems

private org.opensaml.xml.util.XMLObjectChildrenList<RefItem> refItems

Constructor Detail

Subscription

protected Subscription(java.lang.String namespaceURI,
                       java.lang.String elementLocalName,
                       java.lang.String namespacePrefix)

Method Detail

getNotifyToRef

public java.lang.String getNotifyToRef()

setNotifyToRef

public void setNotifyToRef(java.lang.String notifyToRef)

getAdminNotifyToRef

public java.lang.String getAdminNotifyToRef()

setAdminNotifyToRef

public void setAdminNotifyToRef(java.lang.String adminNotifyToRef)

getStarts

public org.joda.time.DateTime getStarts()

setStarts

public void setStarts(org.joda.time.DateTime starts)

getExpires

public org.joda.time.DateTime getExpires()

setExpires

public void setExpires(org.joda.time.DateTime expires)

getId

public java.lang.String getId()

setId

public void setId(java.lang.String id)

getIncludeData

public Subscription.IncludeDataEnum getIncludeData()

setIncludeData

public void setIncludeData(Subscription.IncludeDataEnum includeData)

setSubscriptionID

public void setSubscriptionID(java.lang.String subscriptionID)

The subscriptionID XML attribute MUST be unique within all subscriptions a WSC has at a WSP

Parameters:

subscriptionID -

getSubscriptionID

public java.lang.String getSubscriptionID()

A unique id for this WSC

Returns:

getRefItems

public org.opensaml.xml.util.XMLObjectChildrenList<RefItem> getRefItems()

getExtensions

public org.opensaml.xml.util.XMLObjectChildrenList<Extension> getExtensions()

getOrderedChildren

public java.util.List<org.opensaml.xml.XMLObject> getOrderedChildren()