*** This API provides Binary Compatibility only, not Source Compatibility ***

com.sas.services.information.metadata
Interface SubscriberInterface

All Superinterfaces:

MetadataInterface,

All Known Subinterfaces:

ContentSubscriberInterface, EventSubscriberInterface

All Known Implementing Classes:

OMRSubscriber,

public interface SubscriberInterface

extends MetadataInterface

Subscriber interface;

Since:

1.1

Field Summary

static int	SUBSCRIBER_CONTENT
static int	SUBSCRIBER_EVENT

Fields inherited from interface com.sas.services.information.metadata.MetadataInterface

PERMISSION_READMETADATA, PERMISSION_WRITEMETADATA

Method Summary

ContentDestination	getContentDestination() Get the content destination for this subscriber
String	getDeliveryTransport() Gets the preferred delivery transport for this subscriber.
PersonInterface	getPerson() Returns the user this subscriber identity belongs to.
String	getQueueName() Gets the queue name to deliver to for this subscriber.
List	getSubscribedChannels() Get a list of the channels subscribed to by this Subscriber identity.
void	setContentDestination(DirectoryInterface basePathDirectory, String relativePath) Set the content destination for this subscriber.
void	setDeliveryTransport(String deliveryTransport) Sets the delivery transport for this subscriber.
void	setPerson(PersonInterface person) Sets the user this subscriber identity belongs to.
void	setQueueName(String queueName) Sets the queue name this subscriber receives data on.

Methods inherited from interface com.sas.services.information.metadata.MetadataInterface

add, addAccessControl, addAttribute, addAttributes, addExtension, addKeyword, addPermissions, addRemark, addTransactionListener, checkin, checkout, commit, copyTo, delete, deleteAttribute, deleteAttributes, getAccessControls, getAttribute, getAttributes, getCreateDate, getDescription, getEntityKey, getEntityURL, getExtensions, getGUID, getIdentities, getKeywords, getModifyDate, getName, getParentPath, getParents, getPath, getPaths, getPathUrl, getPathUrl, getPermission, getPermissions, getPermissions, getPreviousVersionNames, getRemarksList, getReposId, getRepository, getRepositoryEntity, getReposKey, getTrackingId, getType, getVersion, isAuthorized, isLoggingEnabled, logMessage, mapNameToFilesystem, mapUrlToFilesystem, moveTo, newServiceObject, refresh, removeAccessControl, removeExtension, removeKeyword, removePermissions, rollback, setAttribute, setAttributes, setDescription, setGUID, setKeywords, setName, setPermission, setRemarksList, setRepository, startTransaction, transactionEvent, uncheckout, update, version

Field Detail

SUBSCRIBER_CONTENT

public static final int SUBSCRIBER_CONTENT

SUBSCRIBER_EVENT

public static final int SUBSCRIBER_EVENT

Method Detail

getPerson

public PersonInterface getPerson()
                          throws RemoteException

Returns the user this subscriber identity belongs to.

Returns:

The context of the user's entry

Throws:

RemoteException - if a network anomaly is encountered.

setPerson

public void setPerson(PersonInterface person)
               throws RemoteException

Sets the user this subscriber identity belongs to.

Parameters:

person - The person

Throws:

RemoteException - if a network anomaly is encountered.

getDeliveryTransport

public String getDeliveryTransport()
                            throws RemoteException

Gets the preferred delivery transport for this subscriber.

Returns:

The delivery transport.

Throws:

RemoteException - if a network anomaly is encountered.

setDeliveryTransport

public void setDeliveryTransport(String deliveryTransport)
                          throws RemoteException

Sets the delivery transport for this subscriber.

Parameters:

deliveryTransport - The new transport.

Throws:

RemoteException - if a network anomaly is encountered.

getQueueName

public String getQueueName()
                    throws RemoteException

Gets the queue name to deliver to for this subscriber.

Returns:

The message queue this subscriber recieves published information on

Throws:

RemoteException - if a network anomaly is encountered.

setQueueName

public void setQueueName(String queueName)
                  throws RemoteException

Sets the queue name this subscriber receives data on.

Parameters:

queueName - The new queue name to deliver to for this subscriber.

Throws:

RemoteException - if a network anomaly is encountered.

getContentDestination

public ContentDestination getContentDestination()
                                         throws RemoteException

Get the content destination for this subscriber

Returns:

a Directory representing the preferred content destination for this subscriber.

Throws:

RemoteException - in the event of remote object failure.

setContentDestination

public void setContentDestination(DirectoryInterface basePathDirectory,
                                  String relativePath)
                           throws RemoteException

Set the content destination for this subscriber.

Parameters:

basePathDirectory - A Directory representing the content destination's base path.

relativePath - Relative path.

Throws:

RemoteException - in the event of remote object failure.

getSubscribedChannels

public List getSubscribedChannels()
                           throws ServiceException,
                                  RemoteException

Get a list of the channels subscribed to by this Subscriber identity.

Returns:

a List of ChannelInterface objects.

Throws:

ServiceException - if a repository error occurs.

RemoteException - in the event of remote object failure.

*** This API provides Binary Compatibility only, not Source Compatibility ***