com.sas.services.information.metadata
Class MessageQueueFilter

com.sas.services.information.metadata.MessageQueueFilter

All Implemented Interfaces:

FilterInterface, java.io.Serializable

public class MessageQueueFilter

Filter that may be used to query message queues.

Message queues may be queried for the following cases or any combination thereof:

• message queue ID
• message queue name
• queue manager's ID
• queue manager's type

Since:

9.2

See Also:

Serialized Form

Field Summary

Fields inherited from class com.sas.services.information.Filter

_component

Fields inherited from interface com.sas.services.information.FilterInterface

BASE_SCOPE, FILTERCOMPONENT_UNSUPPORTED, FLAG_OVERRIDE, ONELEVEL_SCOPE, PROTOCOL_DAV, PROTOCOL_HIBERNATE, PROTOCOL_IPOD, PROTOCOL_LDAP, PROTOCOL_OMI, SUBTREE_SCOPE

Constructor Summary

MessageQueueFilter()
Constructs a default instance.

MessageQueueFilter(java.lang.String repositoryId)
Constructs a default instance.

MessageQueueFilter(java.lang.String key, int relation, java.lang.String value)
Constructs a filter for the specified key, relation, and value.

MessageQueueFilter(java.lang.String repositoryId, java.lang.String[] classIdentifiers)
Constructs a default instance.

Method Summary

java.lang.String	getDAVBasicSearchString() Get the filter in the form of a DAV basicsearch XML request.
java.lang.String	getDAVSQLString() Get the filter in the form of a DAV SQL request.
java.lang.String	getOMRType() Gets the type representation for a message queue in an open metadata repository.
java.lang.String	getQueueID() Gets the ID of the message queue which is to be queried.
java.lang.String[]	getQueueManagerClassIdentifiers() Gets a copy of the array of class identifiers which will be used to conduct a search.
java.lang.String	getQueueManagerID() Gets a ID of the message queue which is to be queried.
java.lang.String	getQueueName() Gets the name of the message queue which is to be queried.
java.lang.String	getXMLSelectString() Gets the XML select used to query a message queue from a SAS Metadata Repository.
void	setQueueID(java.lang.String queueID) Specifies the ID of the Transformation which represents the message queue.
void	setQueueManagerClassIdentifiers(java.lang.String[] classIdentifiers) Specifies the ServerComponent[@ClassIdentifier] values which should be queried.
void	setQueueManagerID(java.lang.String queueManagerID) Sets the ID of the server component which manages the message queue.
void	setQueueName(java.lang.String queueName) Specifies the name of the Transformation which represents the message queue.

Methods inherited from class com.sas.services.information.Filter

addProtocol, addSearchOption, component2JCRXPath, component2Select, getDAVBase, getDAVScope, getDAVType, getExplicitSearchString, getFilterComponent, getFilterString, getJCRType, getJCRXPathString, getName, getOMRFlags, getOMROption, getOMRRepository, getOMRSearchString, getOMRTemplate, getProtocols, getRdbmsTable, getSearchOptions, getType, getXPathString, removeProtocol, removeSearchOption, setDAVBase, setDAVScope, setExplicitSearchString, setFilterComponent, setName, setOMRFlags, setOMROption, setOMRRepository, setOMRTemplate, setProtocols, setRdbmsTable, setType, toString

Constructor Detail

MessageQueueFilter

public MessageQueueFilter()

Constructs a default instance.

MessageQueueFilter

public MessageQueueFilter(java.lang.String repositoryId)

Constructs a default instance.

Parameters:

repositoryId - Metadata repository's ID.

MessageQueueFilter

public MessageQueueFilter(java.lang.String repositoryId,
                          java.lang.String[] classIdentifiers)

Constructs a default instance.

Parameters:

repositoryId - Metadata repository's ID.

classIdentifiers - The ClassIdentifiers which the queue manager server must satisfy. Specify null if the class identifier is a don't care.

MessageQueueFilter

public MessageQueueFilter(java.lang.String key,
                          int relation,
                          java.lang.String value)

Constructs a filter for the specified key, relation, and value.

Parameters:

key - Key

relation - Relation

value - Value

Method Detail

getQueueID

public final java.lang.String getQueueID()

Gets the ID of the message queue which is to be queried.

Returns:

ID of the message queue which is to be queried. A null indicates that a message queue is not being queried by its ID.

setQueueID

public final void setQueueID(java.lang.String queueID)

Specifies the ID of the Transformation which represents the message queue.

Parameters:

queueID - ID of the Transformation which represents the message queue.

getQueueName

public final java.lang.String getQueueName()

Gets the name of the message queue which is to be queried.

Returns:

Name of the message queue which is to be queried. A null indicates that a message queue is not being queried by its name.

setQueueName

public final void setQueueName(java.lang.String queueName)

Specifies the name of the Transformation which represents the message queue.

Parameters:

queueName - Name of the Transformation which represents the message queue.

getQueueManagerID

public final java.lang.String getQueueManagerID()

Gets a ID of the message queue which is to be queried.

Returns:

ID of the message queue which is to be queried. A null indicates that a message queue is not being queried by its ID.

setQueueManagerID

public final void setQueueManagerID(java.lang.String queueManagerID)

Sets the ID of the server component which manages the message queue.

Parameters:

queueManagerID - ID of the server component which manages the message queue.

getQueueManagerClassIdentifiers

public final java.lang.String[] getQueueManagerClassIdentifiers()

Gets a copy of the array of class identifiers which will be used to conduct a search.

Returns:

Class identifiers or an empty array if all types of message queues are to be queried.

See Also:

setQueueManagerClassIdentifiers(String[])

setQueueManagerClassIdentifiers

public final void setQueueManagerClassIdentifiers(java.lang.String[] classIdentifiers)

Specifies the ServerComponent[@ClassIdentifier] values which should be queried.

Parameters:

classIdentifiers - ServerComponent[@ClassIdentifier] values which should be queried. If no class identifers are specified, then all types of message queues will be queried. Valid class identifiers for message queues are:

• MetadataUtil.CLASSID_MESSAGEQUEUE_WEBSPHERE
• MetadataUtil.CLASSID_MESSAGEQUEUE_MS

getOMRType

public java.lang.String getOMRType()

Gets the type representation for a message queue in an open metadata repository.

Specified by:

getOMRType in interface FilterInterface

Overrides:

getOMRType in class Filter

Returns:

"Transformation".

getXMLSelectString

public java.lang.String getXMLSelectString()

Gets the XML select used to query a message queue from a SAS Metadata Repository.

Specified by:

getXMLSelectString in interface FilterInterface

Overrides:

getXMLSelectString in class Filter

Returns:

XML select.

getDAVBasicSearchString

public java.lang.String getDAVBasicSearchString()

Get the filter in the form of a DAV basicsearch XML request. This is described in the WebDAV SEARCH proposal.

Specified by:

getDAVBasicSearchString in interface FilterInterface

Overrides:

getDAVBasicSearchString in class Filter

Returns:

An XML basicsearch request to pass to a DAV server.

getDAVSQLString

public java.lang.String getDAVSQLString()

Get the filter in the form of a DAV SQL request. This is aimed at the Microsoft servers - Internet Information Server, SharePoint Portal Server and Exchange server.

Specified by:

getDAVSQLString in interface FilterInterface

Overrides:

getDAVSQLString in class Filter

Returns:

An XML DAV SQL request to pass to a DAV server.