com.sas.services.information.metadata
Interface ContentSubscriberInterface

All Superinterfaces:

MetadataInterface, SubscriberInterface

All Known Implementing Classes:

LdapContentSubscriber, LdapSubscriber, OMRContentSubscriber

public interface ContentSubscriberInterface

extends SubscriberInterface

Package subscriber interface.

Since:

1.1

Field Summary

static String	DEFAULT_EMAIL_FORMAT The default Email format.
static String	DEFAULT_WEBDAV_URL_TYPE The default WebDAV URL type code.
static String	EMAIL_FORMAT_HTML Email format code: HTML
static String	EMAIL_FORMAT_TEXT Email format code: text
static String	EMAIL_TYPE
static String	WEBDAV_URL_TYPE_COLLECTION WebDAV URL type code: collection
static String	WEBDAV_URL_TYPE_PARENT WebDAV URL type code: 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

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.
String	getMail() Gets the mail address to send to for this subscriber.
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	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 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, 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

EMAIL_FORMAT_HTML

public static final String EMAIL_FORMAT_HTML

Email format code: HTML

EMAIL_FORMAT_TEXT

public static final String EMAIL_FORMAT_TEXT

Email format code: text

DEFAULT_EMAIL_FORMAT

public static final String DEFAULT_EMAIL_FORMAT

The default Email format.

EMAIL_TYPE

public static final String EMAIL_TYPE

WEBDAV_URL_TYPE_COLLECTION

public static final String WEBDAV_URL_TYPE_COLLECTION

WebDAV URL type code: collection

WEBDAV_URL_TYPE_PARENT

public static final String WEBDAV_URL_TYPE_PARENT

WebDAV URL type code: parent

DEFAULT_WEBDAV_URL_TYPE

public static final String DEFAULT_WEBDAV_URL_TYPE

The default WebDAV URL type code.

Method Detail

getMail

public String getMail()
               throws RemoteException

Gets the mail address to send to for this subscriber.

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.

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. The format will be one of the following:

• EMAIL_FORMAT_HTML
• EMAIL_FORMAT_TEXT

Returns:

The preferred format for published email for this subscriber. This value will be one of EMAIL_FORMAT_HTML or EMAIL_FORMAT_TEXT

Throws:

RemoteException - if a network anomaly is encountered.

setEmailFormat

public void setEmailFormat(String emailFormat)
                    throws RemoteException

Sets the preferred email format for this subscriber. The format must be one of the following:

• EMAIL_FORMAT_HTML
• EMAIL_FORMAT_TEXT

Parameters:

emailFormat - The preferred email format. This value must be one of EMAIL_FORMAT_HTML or EMAIL_FORMAT_TEXT

Throws:

RemoteException - if a network anomaly is encountered.

getArchiveReceiveBy

public String getArchiveReceiveBy()
                           throws RemoteException

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

Returns:

The preferred receive mechanism for this subscriber.

Throws:

RemoteException - if a network anomaly is encountered.

setArchiveReceiveBy

public void setArchiveReceiveBy(String receiveBy)
                         throws RemoteException

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

Parameters:

receiveBy - method for receiving archive data.

Throws:

RemoteException - if a network anomaly is encountered.

nameValueInclusionFilters

public List nameValueInclusionFilters()
                               throws RemoteException

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

Returns:

The name/value inclusion filter iterator

addNameValueInclusionFilter

public void addNameValueInclusionFilter(String filter)
                                 throws RemoteException

Adds a name/value inclusion filter to the subscriber.

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.

Parameters:

filter - The package inclusion filter to remove.

Throws:

RemoteException - if a network anomaly is encountered.

nameValueExclusionFilters

public List nameValueExclusionFilters()
                               throws RemoteException

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

Returns:

The name/value exclusion filter List.

Throws:

RemoteException - if a network anomaly is encountered.

addNameValueExclusionFilter

public void addNameValueExclusionFilter(String filter)
                                 throws RemoteException

Adds a name/value exclusion filter to the subscriber.

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.

Parameters:

filter - The package exclusion filter to remove.

Throws:

RemoteException - if a network anomaly is encountered.

entryExclusionFilters

public List entryExclusionFilters()
                           throws RemoteException

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

Returns:

the entry exclusion filters for this user.

Throws:

RemoteException - if a network anomaly is encountered.

addEntryExclusionFilter

public void addEntryExclusionFilter(String filter)
                             throws RemoteException

Add an entry exclusion filter to this subscriber.

Parameters:

filter - The new entry exclusion filter.

Throws:

RemoteException - if a network anomaly is encountered.

removeEntryExclusionFilter

public void removeEntryExclusionFilter(String filter)
                                throws RemoteException

Remove an entry exclusion filter from this subscriber.

Parameters:

filter - The entry exclusion filter to remove.

Throws:

RemoteException - if a network anomaly is encountered.

entryInclusionFilters

public List entryInclusionFilters()
                           throws RemoteException

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

Returns:

the entry inclusion filters for this user.

Throws:

RemoteException - if a network anomaly is encountered.

addEntryInclusionFilter

public void addEntryInclusionFilter(String filter)
                             throws RemoteException

Add an entry inclusion filter to this subscriber.

Parameters:

filter - The entry inclusion filter to add.

Throws:

RemoteException - if a network anomaly is encountered.

removeEntryInclusionFilter

public void removeEntryInclusionFilter(String filter)
                                throws RemoteException

Remove an entry inclusion filter from the subscriber.

Parameters:

filter - The entry inclusion filter to remove.

Throws:

RemoteException - if a network anomaly is encountered.

fileMimeTypeExclusionFilters

public List fileMimeTypeExclusionFilters()
                                  throws RemoteException

Gets the file MIME type exclusion filters for this user.

Returns:

The file MIME type exclusion filters.

Throws:

RemoteException - if a network anomaly is encountered.

addFileMimeTypeExclusionFilter

public void addFileMimeTypeExclusionFilter(String filter)
                                    throws RemoteException

Add a file type exclusion filter.

Parameters:

filter - The new file type exclusion filter.

Throws:

RemoteException - if a network anomaly is encountered.

removeFileMimeTypeExclusionFilter

public void removeFileMimeTypeExclusionFilter(String filter)
                                       throws RemoteException

Remove a file type exclusion filter.

Parameters:

filter - The file type exclusion filter to remove.

Throws:

RemoteException - if a network anomaly is encountered.

fileMimeTypeInclusionFilters

public List fileMimeTypeInclusionFilters()
                                  throws RemoteException

Gets the file MIME type inclusion filters for this user.

Returns:

The file MIME type inclusion filters.

Throws:

RemoteException - if a network anomaly is encountered.

addFileMimeTypeInclusionFilter

public void addFileMimeTypeInclusionFilter(String filter)
                                    throws RemoteException

Add a file type inclusion filter.

Parameters:

filter - The file type inclusion filter to add.

Throws:

RemoteException - if a network anomaly is encountered.

removeFileMimeTypeInclusionFilter

public void removeFileMimeTypeInclusionFilter(String filter)
                                       throws RemoteException

Remove a file type inclusion filter.

Parameters:

filter - The file type inclusion filter to remove.

Throws:

RemoteException - if a network anomaly is encountered.

getDavUrlType

public String getDavUrlType()
                     throws RemoteException

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

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.

Parameters:

type - The type of url, parent or collection.

Throws:

RemoteException - if a network anomaly is encountered.