com.softwareag.eda.store.api

Interface EDAEventTypeStore

public interface EDAEventTypeStore

Main interface for browsing the event type store. Event type store contains event types which are special schemas and other schemas which are not event type but event types depend on them.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	artifactExists(EDAArtifactID artifactID) Checks whether specified event type or fragment exists in the Event Type Store.
java.util.Map<java.lang.String,java.lang.Object>	extractHeaders(EDAEventTypeID eventTypeID, java.lang.String content) Extracts filterable properties and headers from the event content
EventType	getEventType(EDAEventTypeID id)
java.lang.String	getLocation()
java.lang.String	getSchema(EDAArtifactID artifactID) Extracts the XSD for the specified event type or fragment.
java.util.Collection<EDAArtifactID>	listAllArtifactIDs(java.lang.String namespace) Lists the ArtifactIDs names from specified namespace recursively.
java.util.Collection<java.lang.String>	listAllEventTypeFullNames(java.lang.String namespace) Lists the Event type names from specified namespace recursively.
java.util.Collection<EDAArtifactID>	listArtifactIDs(java.lang.String namespace) Lists the artifact IDs from specified namespace.
java.util.Collection<EDAEventTypeID>	listEventTypeIDs(java.lang.String namespace) Lists the event type IDs from specified namespace.
java.util.Collection<java.lang.String>	listNamespaces(java.lang.String namespace) Lists the children namespaces in the specified namespace.
void	removeSchema(EDAArtifactID artifactID) Removes an event type or fragment XSD from the Event Type Store.
void	updateSchema(EDAArtifactID artifactID, java.lang.String schemaContent) Adds to the Event Type Store or updates the XSD for the specified event type or fragment.
void	validate(EDAEventTypeID eventTypeID, java.lang.String content) Validates the provided content against the XSD schema of the specified event type.

Method Detail

listEventTypeIDs

java.util.Collection<EDAEventTypeID> listEventTypeIDs(java.lang.String namespace)
                                                      throws EDAEventTypeStoreException

Lists the event type IDs from specified namespace.

Parameters:

namespace - desired namespace

Returns:

collection of all even type IDs which have the specified namespace

Throws:

EDAEventTypeStoreException - if the operation fails

listArtifactIDs

java.util.Collection<EDAArtifactID> listArtifactIDs(java.lang.String namespace)
                                                    throws EDAEventTypeStoreException

Lists the artifact IDs from specified namespace.

Parameters:

namespace - desired namespace

Returns:

collection of all artifact IDs which have the specified namespace

Throws:

EDAEventTypeStoreException - if the operation fails

listAllEventTypeFullNames

java.util.Collection<java.lang.String> listAllEventTypeFullNames(java.lang.String namespace)
                                                                 throws EDAEventTypeStoreException

Lists the Event type names from specified namespace recursively.

Parameters:

namespace - desired namespace

Returns:

collection of all artifact IDs which have the specified namespace

Throws:

EDAEventTypeStoreException - if the operation fails

listNamespaces

java.util.Collection<java.lang.String> listNamespaces(java.lang.String namespace)
                                                      throws EDAEventTypeStoreException

Lists the children namespaces in the specified namespace.

Parameters:

namespace - desired namespace

Returns:

collection of sub namespaces

Throws:

EDAEventTypeStoreException - if the operation fails

getSchema

java.lang.String getSchema(EDAArtifactID artifactID)
                           throws EDAEventTypeStoreException

Extracts the XSD for the specified event type or fragment.

Parameters:

artifactID - the ID of the event type or fragment

Returns:

String representation of the XSD

Throws:

EDAEventTypeStoreException - if the operation fails

updateSchema

void updateSchema(EDAArtifactID artifactID,
                java.lang.String schemaContent)
                  throws EDAEventTypeStoreException

Adds to the Event Type Store or updates the XSD for the specified event type or fragment.

Parameters:

artifactID - the ID of the event type or fragment

schemaContent - the String representation of the XSD

Throws:

EDAEventTypeStoreException - if the operation fails

removeSchema

void removeSchema(EDAArtifactID artifactID)
                  throws EDAEventTypeStoreException

Removes an event type or fragment XSD from the Event Type Store.

Parameters:

artifactID - the ID of the event type or fragment

Throws:

EDAEventTypeStoreException - if the operation fails

extractHeaders

java.util.Map<java.lang.String,java.lang.Object> extractHeaders(EDAEventTypeID eventTypeID,
                                                              java.lang.String content)
                                                                throws EDAEventTypeStoreException

Extracts filterable properties and headers from the event content

Parameters:

eventTypeID - the ID of the content's event type

content - content of the event

Returns:

map of filterable properties and headers

Throws:

EDAEventTypeStoreException

validate

void validate(EDAEventTypeID eventTypeID,
            java.lang.String content)
              throws EDAEventTypeStoreException

Validates the provided content against the XSD schema of the specified event type. If the validation fails, an EDAEventTypeStoreException exception is thrown.

Parameters:

eventTypeID - the ID of the content's event type

content - content of the event

Throws:

EDAEventTypeStoreException - gets thrown if the validation is unsuccessful

listAllArtifactIDs

java.util.Collection<EDAArtifactID> listAllArtifactIDs(java.lang.String namespace)
                                                       throws EDAEventTypeStoreException

Lists the ArtifactIDs names from specified namespace recursively.

Parameters:

namespace - target namespace

Returns:

collection of all ArtifactIDs under the given namespace

Throws:

EDAEventTypeStoreException - if the operation fails

artifactExists

boolean artifactExists(EDAArtifactID artifactID)

Checks whether specified event type or fragment exists in the Event Type Store.

Parameters:

artifactID - the ID of the event type or fragment

Returns:

true if the artifact exists

getEventType

EventType getEventType(EDAEventTypeID id)
                       throws EDAEventTypeStoreException

Parameters:

id - - the EDAEventTypeID of the event type object to be created

Returns:

an instance of the EventType class for the specified Event Type ID

Throws:

java.lang.Exception

EDAEventTypeStoreException

getLocation

java.lang.String getLocation()

Returns:

location of the EventTypeStore