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

com.sas.services.information.metadata
Class LdapContentSubscriber

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

All Implemented Interfaces:

ContentSubscriberInterface, MetadataInterface, SubscriberInterface

public class LdapContentSubscriber

extends Metadata

implements ContentSubscriberInterface

LDAP repository representation of a package subscriber.

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

LdapContentSubscriber()
Constructor for LdapContentSubscriber.

LdapContentSubscriber(RepositoryInterface repos, String name, FolderInterface parent)

LdapContentSubscriber(Sassubscriber o)
Constructor for LdapContentSubscriber.

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	addKeyword(String keyword) Adds a keyword to the list of keywords this subscriber is interested in.
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).
ContentDestination	getContentDestination() Get the content destination for this subscriber
String	getDavUrlType() Sets the type of url.
String	getDeliveryTransport() Gets the preferred delivery transport for this subscriber.
String	getDescription() Get the description for this object.
String	getEmailFormat() Gets the email format for this subcriber (Usually html or text).
List	getKeywords() Gets an iterator of keywords for this subscriber.
String	getMail() Gets the mail address to send to for this subscriber.
String	getName() Get the name for this object.
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.
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	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	removeKeyword(String keyword) Removes a keyword from the keyword list for this subscriber.
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	setContentDestination(DirectoryInterface basePathDirectory, String relativepath) Set the content destination for this subscriber.
void	setDavUrlType(String type) Sets the type of url.
void	setDeliveryTransport(String deliveryTransport) Sets the delivery transport for this subscriber.
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.
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, addPermissions, addRemark, addTransactionListener, checkin, checkout, clearInformationService, commit, copyTo, delete, deleteAttribute, deleteAttributes, getAccessControls, getAttribute, getAttributes, getCreateDate, getEntityKey, getEntityURL, getExtensions, getGUID, getIdentities, getInformationService, getModifyDate, 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, refresh, removeAccessControl, removeExtension, 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, addPermissions, addRemark, addTransactionListener, checkin, checkout, commit, copyTo, delete, deleteAttribute, deleteAttributes, getAccessControls, getAttribute, getAttributes, getCreateDate, getEntityKey, getEntityURL, getExtensions, getGUID, getIdentities, getModifyDate, getParentPath, getParents, getPath, getPaths, getPathUrl, getPathUrl, getPermission, getPermissions, getPermissions, getPreviousVersionNames, getRemarksList, getReposId, getRepository, getRepositoryEntity, getReposKey, getTrackingId, getVersion, isAuthorized, isLoggingEnabled, logMessage, mapNameToFilesystem, mapUrlToFilesystem, moveTo, newServiceObject, refresh, removeAccessControl, removeExtension, removePermissions, rollback, setAttribute, setAttributes, setDescription, setGUID, setKeywords, setName, setPermission, setRemarksList, setRepository, startTransaction, transactionEvent, uncheckout, update, version

Constructor Detail

LdapContentSubscriber

public LdapContentSubscriber()
                      throws RemoteException

Constructor for LdapContentSubscriber.

Throws:

RemoteException - if a network anomaly is encountered.

LdapContentSubscriber

public LdapContentSubscriber(Sassubscriber o)
                      throws RemoteException

Constructor for LdapContentSubscriber.

Parameters:

o -

Throws:

RemoteException - if a network anomaly is encountered.

LdapContentSubscriber

public LdapContentSubscriber(RepositoryInterface repos,
                             String name,
                             FolderInterface parent)
                      throws RemoteException

Method Detail

getName

public String getName()
               throws RemoteException

Description copied from interface: MetadataInterface

Get the name for this object.

Specified by:

getName in interface MetadataInterface

Overrides:

getName in class Metadata

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

Returns:

The object name.

Throws:

RemoteException - if an error occurs

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

getDescription

public String getDescription()
                      throws RemoteException

Description copied from interface: MetadataInterface

Get the description for this object.

Specified by:

getDescription in interface MetadataInterface

Overrides:

getDescription in class Metadata

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

Returns:

The object description.

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 user's context

Throws:

RemoteException - if a network anomaly is encountered.

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.

getKeywords

public List getKeywords()
                 throws RemoteException

Gets an iterator of keywords for this subscriber.

Specified by:

getKeywords in interface MetadataInterface

Overrides:

getKeywords in class Metadata

Returns:

keyword List. This can be null, if there are no keywords.

Throws:

RemoteException - if a network anomaly is encountered.

addKeyword

public void addKeyword(String keyword)
                throws RemoteException

Adds a keyword to the list of keywords this subscriber is interested in.

Specified by:

addKeyword in interface MetadataInterface

Overrides:

addKeyword in class Metadata

Parameters:

keyword - a new keyword for this subscriber

Throws:

RemoteException - if a network anomaly is encountered.

removeKeyword

public void removeKeyword(String keyword)
                   throws RemoteException

Removes a keyword from the keyword list for this subscriber.

Specified by:

removeKeyword in interface MetadataInterface

Overrides:

removeKeyword in class Metadata

Parameters:

keyword - The keyword to remove.

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.

Throws:

RemoteException - if a network anomaly is encountered.

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 format

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.

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.

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

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

Throws:

RemoteException - if a network anomaly is encountered.

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

Specified by:

nameValueExclusionFilters in interface ContentSubscriberInterface

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.

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.

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.

Specified by:

entryExclusionFilters in interface ContentSubscriberInterface

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.

Specified by:

addEntryExclusionFilter in interface ContentSubscriberInterface

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.

Specified by:

removeEntryExclusionFilter in interface ContentSubscriberInterface

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.

Specified by:

entryInclusionFilters in interface ContentSubscriberInterface

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.

Specified by:

addEntryInclusionFilter in interface ContentSubscriberInterface

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.

Specified by:

removeEntryInclusionFilter in interface ContentSubscriberInterface

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.

Specified by:

fileMimeTypeExclusionFilters in interface ContentSubscriberInterface

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.

Specified by:

addFileMimeTypeExclusionFilter in interface ContentSubscriberInterface

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.

Specified by:

removeFileMimeTypeExclusionFilter in interface ContentSubscriberInterface

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.

Specified by:

fileMimeTypeInclusionFilters in interface ContentSubscriberInterface

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.

Specified by:

addFileMimeTypeInclusionFilter in interface ContentSubscriberInterface

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.

Specified by:

removeFileMimeTypeInclusionFilter in interface ContentSubscriberInterface

Parameters:

filter - The file type inclusion filter to remove.

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.

Throws:

RemoteException - in the event of remote object failure.

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

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.

Throws:

RemoteException - if a network anomaly is encountered.

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.

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