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

com.sas.services.information.metadata
Class OMRSubscriber

java.lang.Object
  |
  +--java.rmi.server.RemoteObject
        |
        +--java.rmi.server.RemoteServer
              |
              +--java.rmi.server.UnicastRemoteObject
                    |
                    +--com.sas.services.information.metadata.Metadata
                          |
                          +--com.sas.services.information.metadata.OMRSubscriber

All Implemented Interfaces:

MetadataInterface, SubscriberInterface

Direct Known Subclasses:

OMRContentSubscriber, OMREventSubscriber

public abstract class OMRSubscriber

extends Metadata

implements SubscriberInterface

Publishing framework subscriber persisted in a SAS Metadata Repository.

Since:

1.1

See Also:

Serialized Form

Fields inherited from class com.sas.services.information.metadata.Metadata

_repository, _repositoryFlag, _repositoryObject, formats, gmtZone, REPOSITORY_DAV, REPOSITORY_LDAP, REPOSITORY_NONE, REPOSITORY_OMR

Fields inherited from class java.rmi.server.RemoteObject

ref

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

SUBSCRIBER_CONTENT, SUBSCRIBER_EVENT

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

PERMISSION_READMETADATA, PERMISSION_WRITEMETADATA

Constructor Summary

	OMRSubscriber()
protected	OMRSubscriber(Class theClass)
	OMRSubscriber(ITSubscriber o)
protected	OMRSubscriber(ITSubscriber o, Class theClass)
protected	OMRSubscriber(ITSubscriberImpl_Stub o, Class theClass)
	OMRSubscriber(ITSubscriberImpl o)
protected	OMRSubscriber(ITSubscriberImpl o, Class theClass)

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.
protected abstract ServerComponent	getServerComponent(List servers) Gets the server component for the delivery transport associated with this subscriber.
List	getSubscribedChannels() Get a list of the channels subscribed to by this Subscriber identity.
String	getType() Get the object type.
void	refresh() Refresh the data for this object from the repository.
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 class com.sas.services.information.metadata.Metadata

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

Methods inherited from class java.rmi.server.UnicastRemoteObject

clone, exportObject, exportObject, exportObject, unexportObject

Methods inherited from class java.rmi.server.RemoteServer

getClientHost, getLog, setLog

Methods inherited from class java.rmi.server.RemoteObject

equals, getRef, hashCode, toString, toStub

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

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, getVersion, isAuthorized, isLoggingEnabled, logMessage, mapNameToFilesystem, mapUrlToFilesystem, moveTo, newServiceObject, removeAccessControl, removeExtension, removeKeyword, removePermissions, rollback, setAttribute, setAttributes, setDescription, setGUID, setKeywords, setName, setPermission, setRemarksList, setRepository, startTransaction, transactionEvent, uncheckout, update, version

Constructor Detail

OMRSubscriber

public OMRSubscriber()
              throws RemoteException

OMRSubscriber

public OMRSubscriber(ITSubscriber o)
              throws RemoteException

OMRSubscriber

public OMRSubscriber(ITSubscriberImpl o)
              throws RemoteException

OMRSubscriber

protected OMRSubscriber(Class theClass)
                 throws RemoteException

OMRSubscriber

protected OMRSubscriber(ITSubscriber o,
                        Class theClass)
                 throws RemoteException

OMRSubscriber

protected OMRSubscriber(ITSubscriberImpl o,
                        Class theClass)
                 throws RemoteException

OMRSubscriber

protected OMRSubscriber(ITSubscriberImpl_Stub o,
                        Class theClass)
                 throws RemoteException

Method Detail

getType

public String getType()
               throws RemoteException

Description copied from interface: MetadataInterface

Get the object type. Subclasses of Metadata will return a repository-neutral type string. If no subclass exists, Metadata returns the repository-specific type.

Specified by:

getType in interface MetadataInterface

Overrides:

getType in class Metadata

Following copied from interface: com.sas.services.information.metadata.MetadataInterface

Returns:

A type string for the object.

Throws:

RemoteException - if an error occurs

getPerson

public PersonInterface getPerson()
                          throws RemoteException

Returns the user this subscriber identity belongs to.

Specified by:

getPerson in interface SubscriberInterface

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.

Specified by:

setPerson in interface SubscriberInterface

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.

Specified by:

getDeliveryTransport in interface SubscriberInterface

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.

Specified by:

setDeliveryTransport in interface SubscriberInterface

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.

Specified by:

getQueueName in interface SubscriberInterface

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.

Specified by:

setQueueName in interface SubscriberInterface

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

Specified by:

getContentDestination in interface SubscriberInterface

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.

Specified by:

setContentDestination in interface SubscriberInterface

Parameters:

basePathDirectory - A Directory representing the content destination.

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.

Specified by:

getSubscribedChannels in interface SubscriberInterface

Returns:

a List of ChannelInterface objects.

Throws:

ServiceException - if a repository error occurs.

RemoteException - in the event of remote object failure.

refresh

public void refresh()
             throws ServiceException,
                    RemoteException

Refresh the data for this object from the repository. The subscriber's attributes as well as the following associations will be refreshed:

• ChannelSubscriptions

Specified by:

refresh in interface MetadataInterface

Overrides:

refresh in class Metadata

Throws:

ServiceException - if a repository error occurs.

RemoteException - in the event of remote object failure.

getServerComponent

protected abstract ServerComponent getServerComponent(List servers)

Gets the server component for the delivery transport associated with this subscriber.

Parameters:

servers - List of servers.

Returns:

@return ServerComponent representing an HTTP server or null if one was not defined.

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