com.sas.edir.delivery
Interface Subscriber

All Superinterfaces:

Caching, Entity, TrackedObject

public interface Subscriber

extends Entity

A Subscriber provides information required by the SAS Publish function to deliver content to a user.

Version:

1.0

Author:

SAS

Fields inherited from interface com.sas.edir.Entity

PROPERTY_CHANGED, SUBPROPERTY_CHANGED

Method Summary

boolean	addEntryExclusionFilter(java.lang.String filter) Add an entry exclusion filter to this subscriber.
boolean	addEntryInclusionFilter(java.lang.String filter) Add an entry inclusion filter to this subscriber.
boolean	addFileMimeTypeExclusionFilter(java.lang.String filter) Add a file type exclusion filter.
boolean	addFileMimeTypeInclusionFilter(java.lang.String filter) Add a file type inclusion filter.
void	addKeyword(java.lang.String keyword) Adds a keyword to the list of keywords this subscriber is interested in.
boolean	addNameValueExclusionFilter(java.lang.String filter) Add a name/value exclusion filter to the subscriber
boolean	addNameValueInclusionFilter(java.lang.String filter) Add a name/value inclusion filter to the subscriber
java.util.Iterator	entryExclusionFilters() Gets the entry exclusion filters defined for filtering content to this subscriber.
java.util.Iterator	entryInclusionFilters() Gets the entry inclusion filters defined for filtering content to this subscriber.
java.util.Iterator	fileMimeTypeExclusionFilters() Gets the file MIME type exclusion filters for this user.
java.util.Iterator	fileMimeTypeInclusionFilters() Gets the file MIME type inclusion filters for this user.
java.lang.String	getArchiveReceiveBy() Gets the receive method this subscriber prefers (value or reference).
java.lang.String	getDeliveryTransport() Gets the preferred delivery transport for this subscriber.
java.lang.String	getEmailFormat() Gets the email format for this subcriber (Usually html or text).
java.util.Iterator	getKeywordIterator() Gets an iterator of keywords for this subscriber.
java.lang.String	getMail() Gets the mail address to send to for this subscriber.
java.lang.String	getQueueName() Gets the queue name to deliver to for this subscriber
User	getUser() Returns the User that this subscriber identity belongs to
java.lang.String	getUserContext() Returns the DN of the user this subscriber identity belongs to
java.util.Iterator	groupIterator() Gets the groups this subscriber is a member of.
java.util.Iterator	groupIterator(java.util.Comparator compare) Gets the groups this subscriber is a member of, sorted using comparator
java.util.Iterator	nameValueExclusionFilters() Gets the name/value exclusion filters defined for filtering data received by this subscriber identity.
java.util.Iterator	nameValueInclusionFilters() Gets the name/value inclusion filters defined for filtering data received by this subscriber identity.
java.lang.String	removeEntryExclusionFilter(java.lang.String filter) Remove an entry exclusion filter from this subscriber.
java.lang.String	removeEntryInclusionFilter(java.lang.String filter) Remove an entry inclusion filter from the subscriber.
java.lang.String	removeFileMimeTypeExclusionFilter(java.lang.String filter) Remove a file type exclusion filter.
java.lang.String	removeFileMimeTypeInclusionFilter(java.lang.String filter) Remove a file type inclusion filter.
void	removeKeyword(java.lang.String keyword) Removes a keyword from the keyword list for this subscriber.
java.lang.String	removeNameValueExclusionFilter(java.lang.String filter) Remove a name/value exclusion filter from the subscriber.
java.lang.String	removeNameValueInclusionFilter(java.lang.String filter) Remove a name/value inclusion filter from the subscriber.
void	setArchiveReceiveBy(java.lang.String receiveBy) Sets the preferred mechanism for receiving published archives (value or reference).
void	setDeliveryTransport(java.lang.String deliveryTransport) Sets the delivery transport for this subscriber.
void	setEmailFormat(java.lang.String emailFormat) Sets the preferred email format for this subscriber.
void	setMail(java.lang.String mail) Sets the mail address to send to for this user
void	setQueueName(java.lang.String queueName) Sets the queue name this subscriber receives data on.
void	setUserContext(java.lang.String userContext) Sets the DN of the user this subscriber identity belongs to

Methods inherited from interface com.sas.edir.Entity

addPropertyChangeListener, getContext, getCreateTime, getCreatorsName, getDescription, getEnterpriseDirectory, getGuid, getModifiersName, getModifyTime, getName, getObjectclass, removeModificationItems, removePropertyChangeListener, setDescription, setGuid, setName, setObjectclass

Methods inherited from interface com.sas.edir.Caching

edirUpdateStore, getTimeToLive, isExpired, refreshCache, refreshCachedObjects, releaseCache, setDirty, setTimeToLive, setTimeToLive, updateStore

Methods inherited from interface com.sas.edir.TrackedObject

getTrackingId, getUserData, setUserData

Method Detail

getUserContext

public java.lang.String getUserContext()

Returns the DN of the user this subscriber identity belongs to

Returns:

The context of the user's entry

setUserContext

public void setUserContext(java.lang.String userContext)

Sets the DN of the user this subscriber identity belongs to

Parameters:

userContext - The user's context

getMail

public java.lang.String getMail()

Gets the mail address to send to for this subscriber.

Returns:

The mail address

setMail

public void setMail(java.lang.String mail)

Sets the mail address to send to for this user

Parameters:

mail - The mail address

getKeywordIterator

public java.util.Iterator getKeywordIterator()

Gets an iterator of keywords for this subscriber.

Returns:

keyword iterator

addKeyword

public void addKeyword(java.lang.String keyword)

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

Parameters:

keyword - a new keyword for this subscriber

removeKeyword

public void removeKeyword(java.lang.String keyword)

Removes a keyword from the keyword list for this subscriber.

Parameters:

keyword - The keyword to remove.

getEmailFormat

public java.lang.String getEmailFormat()

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

Returns:

The preferred format for published email for this subscriber.

setEmailFormat

public void setEmailFormat(java.lang.String emailFormat)

Sets the preferred email format for this subscriber.

Parameters:

emailFormat - The preferred email formatl

getDeliveryTransport

public java.lang.String getDeliveryTransport()

Gets the preferred delivery transport for this subscriber.

Returns:

The delivery transport.

setDeliveryTransport

public void setDeliveryTransport(java.lang.String deliveryTransport)

Sets the delivery transport for this subscriber.

Parameters:

deliveryTransport - The new transport.

getQueueName

public java.lang.String getQueueName()

Gets the queue name to deliver to for this subscriber

Returns:

The message queue this subscriber recieves published information on

setQueueName

public void setQueueName(java.lang.String queueName)

Sets the queue name this subscriber receives data on.

Parameters:

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

getArchiveReceiveBy

public java.lang.String getArchiveReceiveBy()

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

Returns:

The preferred receive mechanism for this subscriber.

setArchiveReceiveBy

public void setArchiveReceiveBy(java.lang.String receiveBy)

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

Parameters:

receiveBy - method for receiving archive data.

groupIterator

public java.util.Iterator groupIterator()

Gets the groups this subscriber is a member of.

Returns:

An Group iteration

groupIterator

public java.util.Iterator groupIterator(java.util.Comparator compare)

Gets the groups this subscriber is a member of, sorted using comparator

Returns:

A Group Iteration.

getUser

public User getUser()

Returns the User that this subscriber identity belongs to

Returns:

A User

nameValueInclusionFilters

public java.util.Iterator nameValueInclusionFilters()

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

Returns:

The name/value inclusion filter iterator

addNameValueInclusionFilter

public boolean addNameValueInclusionFilter(java.lang.String filter)

Add a name/value inclusion filter to the subscriber

Parameters:

filter - The new package inclusion filter.

removeNameValueInclusionFilter

public java.lang.String removeNameValueInclusionFilter(java.lang.String filter)

Remove a name/value inclusion filter from the subscriber.

Parameters:

filter - The package inclusion filter to remove.

nameValueExclusionFilters

public java.util.Iterator nameValueExclusionFilters()

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

Returns:

The name/value exclusion filter iterator

addNameValueExclusionFilter

public boolean addNameValueExclusionFilter(java.lang.String filter)

Add a name/value exclusion filter to the subscriber

Parameters:

filter - The new package exclusion filter.

removeNameValueExclusionFilter

public java.lang.String removeNameValueExclusionFilter(java.lang.String filter)

Remove a name/value exclusion filter from the subscriber.

Parameters:

filter - The package exclusion filter to remove.

entryExclusionFilters

public java.util.Iterator entryExclusionFilters()

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

Returns:

the entry exclusion filters for this user.

addEntryExclusionFilter

public boolean addEntryExclusionFilter(java.lang.String filter)

Add an entry exclusion filter to this subscriber.

Parameters:

filter - The new entry exclusion filter.

removeEntryExclusionFilter

public java.lang.String removeEntryExclusionFilter(java.lang.String filter)

Remove an entry exclusion filter from this subscriber.

Parameters:

filter - The entry exclusion filter to remove.

entryInclusionFilters

public java.util.Iterator entryInclusionFilters()

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

Returns:

the entry inclusion filters for this user.

addEntryInclusionFilter

public boolean addEntryInclusionFilter(java.lang.String filter)

Add an entry inclusion filter to this subscriber.

Parameters:

filter - The entry inclusion filter to add.

removeEntryInclusionFilter

public java.lang.String removeEntryInclusionFilter(java.lang.String filter)

Remove an entry inclusion filter from the subscriber.

Parameters:

filter - The entry inclusion filter to remove.

fileMimeTypeExclusionFilters

public java.util.Iterator fileMimeTypeExclusionFilters()

Gets the file MIME type exclusion filters for this user.

Returns:

The file MIME type exclusion filters.

addFileMimeTypeExclusionFilter

public boolean addFileMimeTypeExclusionFilter(java.lang.String filter)

Add a file type exclusion filter.

Parameters:

filter - The new file type exclusion filter.

removeFileMimeTypeExclusionFilter

public java.lang.String removeFileMimeTypeExclusionFilter(java.lang.String filter)

Remove a file type exclusion filter.

Parameters:

filter - The file type exclusion filter to remove.

fileMimeTypeInclusionFilters

public java.util.Iterator fileMimeTypeInclusionFilters()

Gets the file MIME type inclusion filters for this user.

Returns:

The file MIME type inclusion filters.

addFileMimeTypeInclusionFilter

public boolean addFileMimeTypeInclusionFilter(java.lang.String filter)

Add a file type inclusion filter.

Parameters:

filter - The file type inclusion filter to add.

removeFileMimeTypeInclusionFilter

public java.lang.String removeFileMimeTypeInclusionFilter(java.lang.String filter)

Remove a file type inclusion filter.

Parameters:

filter - The file type inclusion filter to remove.