org.codice.ddf.catalog.subscriptionstore.common

Class SubscriptionMetadata

java.lang.Object

org.codice.ddf.catalog.subscriptionstore.common.SubscriptionMetadata

All Implemented Interfaces:

MarshalledSubscription, SubscriptionIdentifier, SubscriptionType

public class SubscriptionMetadata
extends Object
implements SubscriptionIdentifier, MarshalledSubscription

An immutable data object for storing subscriptions in the PersistentStore.

SubscriptionMetadata wraps a serialized Subscription with no assumption as to the specific serialization format, only the guarantee that metadata objects with the same type are the same format. That means metadata objects with the same type can be serialized and deserialized the same way, using the same instance of SubscriptionFactory.

Constructor Summary

Constructors

Constructor and Description
SubscriptionMetadata(String typeName, String filter, String callbackAddress)
SubscriptionMetadata(String typeName, String filter, String callbackAddress, String id)

Method Summary

Modifier and Type	Method and Description
String	getCallbackAddress() Get the subscription callback address.
String	getFilter() Get the subscription filter as a marshalled string.
String	getId() Uniquely identifies a single subscription for a given type in the SubscriptionContainer.
String	getTypeName() Retrieve a unique type.

Methods inherited from class java.lang.Object

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

Constructor Detail

SubscriptionMetadata

public SubscriptionMetadata(String typeName,
                            String filter,
                            String callbackAddress)

SubscriptionMetadata

public SubscriptionMetadata(String typeName,
                            String filter,
                            String callbackAddress,
                            String id)

Method Detail

getId

public String getId()

Description copied from interface: SubscriptionIdentifier

Uniquely identifies a single subscription for a given type in the SubscriptionContainer.

Specified by:

getId in interface SubscriptionIdentifier

Returns:

a subscription's unique key.

getTypeName

public String getTypeName()

Description copied from interface: SubscriptionType

Retrieve a unique type.

Specified by:

getTypeName in interface SubscriptionType

Returns:

the type identifier.

getFilter

public String getFilter()

Description copied from interface: MarshalledSubscription

Get the subscription filter as a marshalled string. This can be JSON, XML with any schema, etc. No guarantees are made to the format of this String, only that providing it to the correct SubscriptionFactory will yield a valid instance of Subscription.

Specified by:

getFilter in interface MarshalledSubscription

Returns:

the marshalled subscription filter.

getCallbackAddress

public String getCallbackAddress()

Description copied from interface: MarshalledSubscription

Get the subscription callback address. While current endpoints conform to using a URL for their DeliveryMethod, this is not a guarantee.

Specified by:

getCallbackAddress in interface MarshalledSubscription

Returns:

the callback address to send events to for this Subscription.