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

com.sas.services.information.metadata
Class OMRContentSubscriber

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
                                |
                                +--com.sas.services.information.metadata.OMRContentSubscriber

All Implemented Interfaces:

ContentSubscriberInterface, MetadataInterface, SubscriberInterface

public class OMRContentSubscriber

extends OMRSubscriber

implements ContentSubscriberInterface

Package subscriber persisted in a SAS Metadata Repository.

Since:

1.1

See Also:

Serialized Form

Field Summary

static String	FILTER_EXCLUSION_ENTRY Entry exclusion filter role.
static String	FILTER_EXCLUSION_FILEMIMETYPE Name/value exclusion filter role.
static String	FILTER_EXCLUSION_NAMEVALUE Name/value exclusion filter role.
static String	FILTER_INCLUSION_ENTRY Entry inclusion filter role.
static String	FILTER_INCLUSION_FILEMIMETYPE Name/value inclusion filter role.
static String	FILTER_INCLUSION_NAMEVALUE Name/value inclusion filter role.

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.ContentSubscriberInterface

DEFAULT_EMAIL_FORMAT, DEFAULT_WEBDAV_URL_TYPE, EMAIL_FORMAT_HTML, EMAIL_FORMAT_TEXT, EMAIL_TYPE, WEBDAV_URL_TYPE_COLLECTION, WEBDAV_URL_TYPE_PARENT

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

OMRContentSubscriber()

OMRContentSubscriber(ITContentSubscriber o)

OMRContentSubscriber(ITContentSubscriberImpl o)

OMRContentSubscriber(RepositoryInterface repos, String name, FolderInterface parent)

Method Summary

void	addEntryExclusionFilter(String filter) Add an entry exclusion filter to this subscriber.
void	addEntryInclusionFilter(String filter) Add an entry inclusion filter to this subscriber.
void	addFileMimeTypeExclusionFilter(String filter) Add a file type exclusion filter.
void	addFileMimeTypeInclusionFilter(String filter) Add a file type inclusion filter.
void	addNameValueExclusionFilter(String filter) Adds a name/value exclusion filter to the subscriber.
void	addNameValueInclusionFilter(String filter) Adds a name/value inclusion filter to the subscriber.
List	entryExclusionFilters() Gets the entry exclusion filters defined for filtering content to this subscriber.
List	entryInclusionFilters() Gets the entry inclusion filters defined for filtering content to this subscriber.
List	fileMimeTypeExclusionFilters() Gets the file MIME type exclusion filters for this user.
List	fileMimeTypeInclusionFilters() Gets the file MIME type inclusion filters for this user.
String	getArchiveReceiveBy() Gets the receive method this subscriber prefers (value or reference).
String	getDavUrlType() Sets the type of url.
String	getEmailFormat() Gets the email format for this subcriber (Usually html or text).
String	getMail() Gets the mail address to send to for this subscriber.
protected ServerComponent	getServerComponent(List servers) Gets the server component representing an HTTP server.
String	getType() Get the object type.
List	nameValueExclusionFilters() Gets the name/value exclusion filters defined for filtering data received by this subscriber identity.
List	nameValueInclusionFilters() Gets the name/value inclusion filters defined for filtering data received by this subscriber identity.
void	refresh() Refresh the data for this object from the repository.
void	removeEntryExclusionFilter(String filter) Remove an entry exclusion filter from this subscriber.
void	removeEntryInclusionFilter(String filter) Remove an entry inclusion filter from the subscriber.
void	removeFileMimeTypeExclusionFilter(String filter) Remove a file type exclusion filter.
void	removeFileMimeTypeInclusionFilter(String filter) Remove a file type inclusion filter.
void	removeNameValueExclusionFilter(String filter) Remove a name/value exclusion filter from the subscriber.
void	removeNameValueInclusionFilter(String filter) Remove a name/value inclusion filter from the subscriber.
void	setArchiveReceiveBy(String receiveBy) Sets the preferred mechanism for receiving published archives (value or reference).
void	setDavUrlType(String type) Sets the type of url.
void	setEmailFormat(String emailFormat) Sets the preferred email format for this subscriber.
void	setMail(String mail) Sets the mail address to send to for this user.

Methods inherited from class com.sas.services.information.metadata.OMRSubscriber

getContentDestination, getDeliveryTransport, getPerson, getQueueName, getSubscribedChannels, setContentDestination, setDeliveryTransport, setPerson, setQueueName

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.SubscriberInterface

getContentDestination, getDeliveryTransport, getPerson, getQueueName, getSubscribedChannels, setContentDestination, setDeliveryTransport, setPerson, setQueueName

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

Field Detail

FILTER_EXCLUSION_ENTRY

public static final String FILTER_EXCLUSION_ENTRY

Entry exclusion filter role.

FILTER_INCLUSION_ENTRY

public static final String FILTER_INCLUSION_ENTRY

Entry inclusion filter role.

FILTER_EXCLUSION_FILEMIMETYPE

public static final String FILTER_EXCLUSION_FILEMIMETYPE

Name/value exclusion filter role.

FILTER_INCLUSION_FILEMIMETYPE

public static final String FILTER_INCLUSION_FILEMIMETYPE

Name/value inclusion filter role.

FILTER_EXCLUSION_NAMEVALUE

public static final String FILTER_EXCLUSION_NAMEVALUE

Name/value exclusion filter role.

FILTER_INCLUSION_NAMEVALUE

public static final String FILTER_INCLUSION_NAMEVALUE

Name/value inclusion filter role.

Constructor Detail

OMRContentSubscriber

public OMRContentSubscriber()
                     throws RemoteException

OMRContentSubscriber

public OMRContentSubscriber(ITContentSubscriber o)
                     throws RemoteException

OMRContentSubscriber

public OMRContentSubscriber(ITContentSubscriberImpl o)
                     throws RemoteException

OMRContentSubscriber

public OMRContentSubscriber(RepositoryInterface repos,
                            String name,
                            FolderInterface parent)
                     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 OMRSubscriber

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

Returns:

A type string for the object.

Throws:

RemoteException - if an error occurs

getMail

public String getMail()
               throws RemoteException

Gets the mail address to send to for this subscriber.

Specified by:

getMail in interface ContentSubscriberInterface

Returns:

The mail address, or null if there isn't one.

Throws:

RemoteException - if a network anomaly is encountered.

setMail

public void setMail(String mail)
             throws RemoteException

Sets the mail address to send to for this user.

Specified by:

setMail in interface ContentSubscriberInterface

Parameters:

mail - The mail address

Throws:

RemoteException - if a network anomaly is encountered.

getEmailFormat

public String getEmailFormat()
                      throws RemoteException

Gets the email format for this subcriber (Usually html or text).

Specified by:

getEmailFormat in interface ContentSubscriberInterface

Returns:

The preferred format for published email for this subscriber.

setEmailFormat

public void setEmailFormat(String emailFormat)
                    throws RemoteException

Sets the preferred email format for this subscriber.

Specified by:

setEmailFormat in interface ContentSubscriberInterface

Parameters:

emailFormat - The preferred email formatl

getArchiveReceiveBy

public String getArchiveReceiveBy()
                           throws RemoteException

Gets the receive method this subscriber prefers (value or reference).

Specified by:

getArchiveReceiveBy in interface ContentSubscriberInterface

Returns:

The preferred receive mechanism for this subscriber.

setArchiveReceiveBy

public void setArchiveReceiveBy(String receiveBy)
                         throws RemoteException

Sets the preferred mechanism for receiving published archives (value or reference).

Specified by:

setArchiveReceiveBy in interface ContentSubscriberInterface

Parameters:

receiveBy - method for receiving archive data.

nameValueInclusionFilters

public List nameValueInclusionFilters()
                               throws RemoteException

Gets the name/value inclusion filters defined for filtering data received by this subscriber identity.

Specified by:

nameValueInclusionFilters in interface ContentSubscriberInterface

Returns:

The name/value inclusion filter iterator

addNameValueInclusionFilter

public void addNameValueInclusionFilter(String filter)
                                 throws RemoteException

Adds a name/value inclusion filter to the subscriber.

Specified by:

addNameValueInclusionFilter in interface ContentSubscriberInterface

Parameters:

filter - The new package inclusion filter.

Throws:

RemoteException - if a network anomaly is encountered.

removeNameValueInclusionFilter

public void removeNameValueInclusionFilter(String filter)
                                    throws RemoteException

Remove a name/value inclusion filter from the subscriber.

Specified by:

removeNameValueInclusionFilter in interface ContentSubscriberInterface

Parameters:

filter - The package inclusion filter to remove.

Throws:

RemoteException - if a networking issue is encountered.

nameValueExclusionFilters

public List nameValueExclusionFilters()
                               throws RemoteException

Gets the name/value exclusion filters defined for filtering data received by this subscriber identity.

Specified by:

nameValueExclusionFilters in interface ContentSubscriberInterface

Returns:

The name/value exclusion filter List.

addNameValueExclusionFilter

public void addNameValueExclusionFilter(String filter)
                                 throws RemoteException

Adds a name/value exclusion filter to the subscriber.

Specified by:

addNameValueExclusionFilter in interface ContentSubscriberInterface

Parameters:

filter - The new package exclusion filter.

Throws:

RemoteException - if a network anomaly is encountered.

removeNameValueExclusionFilter

public void removeNameValueExclusionFilter(String filter)
                                    throws RemoteException

Remove a name/value exclusion filter from the subscriber.

Specified by:

removeNameValueExclusionFilter in interface ContentSubscriberInterface

Parameters:

filter - The package exclusion filter to remove.

entryExclusionFilters

public List entryExclusionFilters()
                           throws RemoteException

Gets the entry exclusion filters defined for filtering content to this subscriber.

Specified by:

entryExclusionFilters in interface ContentSubscriberInterface

Returns:

the entry exclusion filters for this user.

addEntryExclusionFilter

public void addEntryExclusionFilter(String filter)
                             throws RemoteException

Add an entry exclusion filter to this subscriber.

Specified by:

addEntryExclusionFilter in interface ContentSubscriberInterface

Parameters:

filter - The new entry exclusion filter.

removeEntryExclusionFilter

public void removeEntryExclusionFilter(String filter)
                                throws RemoteException

Remove an entry exclusion filter from this subscriber.

Specified by:

removeEntryExclusionFilter in interface ContentSubscriberInterface

Parameters:

filter - The entry exclusion filter to remove.

entryInclusionFilters

public List entryInclusionFilters()
                           throws RemoteException

Gets the entry inclusion filters defined for filtering content to this subscriber.

Specified by:

entryInclusionFilters in interface ContentSubscriberInterface

Returns:

the entry inclusion filters for this user.

addEntryInclusionFilter

public void addEntryInclusionFilter(String filter)
                             throws RemoteException

Add an entry inclusion filter to this subscriber.

Specified by:

addEntryInclusionFilter in interface ContentSubscriberInterface

Parameters:

filter - The entry inclusion filter to add.

removeEntryInclusionFilter

public void removeEntryInclusionFilter(String filter)
                                throws RemoteException

Remove an entry inclusion filter from the subscriber.

Specified by:

removeEntryInclusionFilter in interface ContentSubscriberInterface

Parameters:

filter - The entry inclusion filter to remove.

fileMimeTypeExclusionFilters

public List fileMimeTypeExclusionFilters()
                                  throws RemoteException

Gets the file MIME type exclusion filters for this user.

Specified by:

fileMimeTypeExclusionFilters in interface ContentSubscriberInterface

Returns:

The file MIME type exclusion filters.

addFileMimeTypeExclusionFilter

public void addFileMimeTypeExclusionFilter(String filter)
                                    throws RemoteException

Add a file type exclusion filter.

Specified by:

addFileMimeTypeExclusionFilter in interface ContentSubscriberInterface

Parameters:

filter - The new file type exclusion filter.

removeFileMimeTypeExclusionFilter

public void removeFileMimeTypeExclusionFilter(String filter)
                                       throws RemoteException

Remove a file type exclusion filter.

Specified by:

removeFileMimeTypeExclusionFilter in interface ContentSubscriberInterface

Parameters:

filter - The file type exclusion filter to remove.

fileMimeTypeInclusionFilters

public List fileMimeTypeInclusionFilters()
                                  throws RemoteException

Gets the file MIME type inclusion filters for this user.

Specified by:

fileMimeTypeInclusionFilters in interface ContentSubscriberInterface

Returns:

The file MIME type inclusion filters.

addFileMimeTypeInclusionFilter

public void addFileMimeTypeInclusionFilter(String filter)
                                    throws RemoteException

Add a file type inclusion filter.

Specified by:

addFileMimeTypeInclusionFilter in interface ContentSubscriberInterface

Parameters:

filter - The file type inclusion filter to add.

removeFileMimeTypeInclusionFilter

public void removeFileMimeTypeInclusionFilter(String filter)
                                       throws RemoteException

Remove a file type inclusion filter.

Specified by:

removeFileMimeTypeInclusionFilter in interface ContentSubscriberInterface

Parameters:

filter - The file type inclusion filter to remove.

getDavUrlType

public String getDavUrlType()
                     throws RemoteException

Sets the type of url. For webDAV servers, the url can either be a parent or collection url.

Specified by:

getDavUrlType in interface ContentSubscriberInterface

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

Returns:

The type of url, parent or collection.

Throws:

RemoteException - if a network anomaly is encountered.

setDavUrlType

public void setDavUrlType(String type)
                   throws RemoteException

Sets the type of url. For webDAV servers, the url can either be a parent or collection url.

Specified by:

setDavUrlType in interface ContentSubscriberInterface

Parameters:

type - The type of url, parent or collection.

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:

• Content destinations
• Email addresses
• Profile owners
• Properties
• Trees

Specified by:

refresh in interface MetadataInterface

Overrides:

refresh in class OMRSubscriber

Throws:

ServiceException - if a repository error occurs.

RemoteException - in the event of remote object failure.

getServerComponent

protected final ServerComponent getServerComponent(List servers)

Gets the server component representing an HTTP server. The first HTTP server encountered will be returned. Note that no check is made to verify whether or not the HTTP server contains WebDAV enabled base paths.

Overrides:

getServerComponent in class OMRSubscriber

Parameters:

servers - List of servers

Returns:

ServerComponent representing an HTTP server that supports WebDAV or null if one was not defined.

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