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

com.sas.services.information.metadata
Class OMRChannel

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

All Implemented Interfaces:

ChannelInterface, MetadataInterface,

public class OMRChannel

extends Metadata

implements ChannelInterface

The Channel class is a "smart" object that implements a generic interface to an IT Channel and hides differences in metadata repositories (OMR and LDAP).

Since:

1.0

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

ARCHIVE_TRANSPORT, NO_TRANSPORT, SMART_OBJECT_TYPE, UNSUPPORTED_TRANSPORT, WEBDAV_TRANSPORT

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

PERMISSION_READMETADATA, PERMISSION_WRITEMETADATA

Constructor Summary

OMRChannel()

OMRChannel(ITChannel o)

OMRChannel(ITChannelImpl o)

OMRChannel(RepositoryInterface repos, String name, FolderInterface parent)
This is the constructor for a new metadata object.

Method Summary

void	addContentSubscriber(ContentSubscriberInterface subscriber) Adds a content subscriber to this channel.
void	addEventSubscriber(EventSubscriberInterface subscriber) Adds an event subscriber to this channel.
void	addSubscriberGroup(GroupInterface group) Add a subscriber group to this channel.
ContentDestination	getArchivePath() Returns a the archive path content information to use as the archive path for this channel.
ContentDestination	getContentDestination() Get the content destination for this channel
String	getDavUrlType() Sets the type of url.
int	getDefaultTransport()
int	getDeliveryTransport() Gets the default transport defined for this channel.
String	getFrequency() Gets the frequency for this channel.
String	getPresentationLanguage() Returns the channel's presentation language.
String	getSubject() Returns this channel's subject.
String	getType() Return a type string to identify this object.
boolean	isContentSubscription(ContentSubscriberInterface subscriber) Determines if a user is subscribed to this channel as a package subscriber.
boolean	isEventSubscription(EventSubscriberInterface subscriber) Determines if a user is subscribed to this channel as an event subscriber.
boolean	isGroupContentSubscription(ContentSubscriberInterface subscriber) Determines if a user is subscribed to this channel through a group.
boolean	isGroupEventSubscription(EventSubscriberInterface subscriber) Determines if a user is subscribed to this channel through a group as an event subscriber.
List	packageList() Returns an iteration of all the packages contained in this channel.
List	packageList(Comparator compare) Returns a sorted List of all the archives contained in this channel.
void	refresh() Refresh the data for this object from the repository.
void	removeContentSubscriber(ContentSubscriberInterface subscriber) Removes a content subscriber from this channel.
void	removeEventSubscriber(EventSubscriberInterface subscriber) Removes an event subscriber from this channel.
void	removeSubscriberGroup(GroupInterface group) Remove a subscriber group from this channel.
void	setArchivePath(DirectoryInterface basePathDir, String relativePath) Set the location of the archive path to use for this channel.
void	setArchivePath(ServerInterface server, String relativePath) Set the location of the archive path to use for this channel.
void	setArchivePath(String path) Set the location of the archive path to use for this channel.
void	setContentDestination(DirectoryInterface basePathDirectory, String relativePath) Set the content destination for this channel.
void	setDavUrlType(String type) Sets the type of url.
void	setDeliveryTransport(int transport) Sets the delivery transport for this channel.
void	setDeliveryTransport(String transport) Sets the delivery transport for this channel.
void	setFrequency(String frequency) Sets the frequency string for this channel.
void	setPresentationLanguage(String language) Sets the channel presentation language.
void	setRepository(RepositoryInterface repos) Set the repository that this item exists in.
void	setSubject(String subject) Sets this channel's subject.
List	subscriberGroupsList(int subscriberType) Returns a List of Group objects that are subscribed to this channel.
List	subscriberList(int subscriberType) Returns a List of all this channel's subscribers.
List	subscriberList(int subscriberType, Comparator compare) Returns a sorted iteration of all this channel's subscribers.
List	subscriberNameList(int subscriberType) Return a List of subscriber names.
String	toString()

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, 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, 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, startTransaction, transactionEvent, uncheckout, update, version

Constructor Detail

OMRChannel

public OMRChannel()
           throws RemoteException

OMRChannel

public OMRChannel(ITChannel o)
           throws RemoteException

OMRChannel

public OMRChannel(ITChannelImpl o)
           throws RemoteException

OMRChannel

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

This is the constructor for a new metadata object. Create the repository entity and set things up.

Parameters:

repos - The repository the new object will reside in.

name - The name of the new object.

parent - The parent folder of the new object.

Method Detail

getType

public String getType()
               throws RemoteException

Return a type string to identify this object.

Specified by:

getType in interface MetadataInterface

Overrides:

getType in class Metadata

Returns:

The type string ("Channel").

getArchivePath

public ContentDestination getArchivePath()
                                  throws ServiceException,
                                         RemoteException

Returns a the archive path content information to use as the archive path for this channel.

Specified by:

getArchivePath in interface ChannelInterface

Returns:

a ContentDestination object that represents the default location for archives published to this channel.

Throws:

ServiceException - in the event of service object failure.

RemoteException - in the event of remote object failure.

setArchivePath

public void setArchivePath(DirectoryInterface basePathDir,
                           String relativePath)
                    throws ServiceException,
                           RemoteException

Set the location of the archive path to use for this channel.

Specified by:

setArchivePath in interface ChannelInterface

Parameters:

basePathDir - A DirectoryInterface representing the base path for this channel

relativePath - A String with the relative path for the channel archive destination.

Throws:

ServiceException - in the event of service object failure.

RemoteException - in the event of remote object failure.

setArchivePath

public void setArchivePath(String path)
                    throws ServiceException,
                           RemoteException

Set the location of the archive path to use for this channel. Sets the archive path to a physical path.

Specified by:

setArchivePath in interface ChannelInterface

Parameters:

path - A String that identifies the absolute physical path.

Throws:

ServiceException - in the event of service object failure.

RemoteException - in the event of remote object failure.

setArchivePath

public void setArchivePath(ServerInterface server,
                           String relativePath)
                    throws ServiceException,
                           RemoteException

Set the location of the archive path to use for this channel. This method should be used when the archive path is defined to be an FTP server.

Specified by:

setArchivePath in interface ChannelInterface

Parameters:

server - A ServerInterface representing the FTP server.

relativePath - A String with the relative path for the channel archive destination.

Throws:

ServiceException - in the event of service object failure.

RemoteException - in the event of remote object failure.

getSubject

public String getSubject()
                  throws RemoteException

Returns this channel's subject.

Specified by:

getSubject in interface ChannelInterface

Returns:

The subject.

setSubject

public void setSubject(String subject)
                throws RemoteException

Sets this channel's subject.

This change is not persisted to the enterprise directory until updateStore is called.

Specified by:

setSubject in interface ChannelInterface

Parameters:

subject - The subject.

getPresentationLanguage

public String getPresentationLanguage()
                               throws RemoteException

Returns the channel's presentation language.

Specified by:

getPresentationLanguage in interface ChannelInterface

Returns:

the presentation language.

setPresentationLanguage

public void setPresentationLanguage(String language)
                             throws RemoteException

Sets the channel presentation language.

This change is not persisted until update is called.

Specified by:

setPresentationLanguage in interface ChannelInterface

Parameters:

language - The new presentation language.

Throws:

RemoteException - in the event of a network error.

setDeliveryTransport

public void setDeliveryTransport(String transport)
                          throws RemoteException

Sets the delivery transport for this channel.

Parameters:

transport - The new delivery transport.

Throws:

RemoteException - in the event of a network error.

getFrequency

public String getFrequency()
                    throws RemoteException

Gets the frequency for this channel. This is only a hint for potential subscribers, not a rule. This string may be displayed to give users an idea of how often content is published.

Specified by:

getFrequency in interface ChannelInterface

Returns:

the frequency that content is published on this channel.

Throws:

RemoteException - in the event of network error.

setFrequency

public void setFrequency(String frequency)
                  throws RemoteException

Sets the frequency string for this channel. This string is just for display, so no attempt is made to verify it as a valid period.

Specified by:

setFrequency in interface ChannelInterface

Parameters:

frequency - The new frequency string.

Throws:

RemoteException - in the event of network error.

getContentDestination

public ContentDestination getContentDestination()
                                         throws RemoteException

Get the content destination for this channel

Specified by:

getContentDestination in interface ChannelInterface

Returns:

a ContentDestination object representing the preferred content destination for this channel. Channel content destinations are currently backed by a WebDAV enabled HTTP server.

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 channel. If the relative path is non-null, a new Directory entry is created, basePathDirectory is associated to it as its parent, and the new directory is associated to the channel as the ContentDestination. If the relative path is null or zero length, the basePathDirectory is associated to the channel as the ContentDestination.

Specified by:

setContentDestination in interface ChannelInterface

Parameters:

basePathDirectory - A Directory representing the content destination.

relativePath - A String with the relative path.

Throws:

RemoteException - in the event of remote object failure.

subscriberList

public List subscriberList(int subscriberType)
                    throws RemoteException

Returns a List of all this channel's subscribers.

Specified by:

subscriberList in interface ChannelInterface

Parameters:

subscriberType - Identifies the type of subscribers to return. Valid subscriber types include SubscriberInterface.SUBSCRIBER_CONTENT or SubscriberInterface.SUBSCRIBER_EVENT. The subscriber type can be ORed in order to return multiple types of subscribers.

Returns:

A List of SubscriberInterface objects.

Throws:

RemoteException - in the event of network error.

subscriberList

public List subscriberList(int subscriberType,
                           Comparator compare)
                    throws RemoteException

Returns a sorted iteration of all this channel's subscribers.

Specified by:

subscriberList in interface ChannelInterface

Parameters:

subscriberType - Identifies the type of subscribers to return. Valid subscriber types include SubscriberInterface.SUBSCRIBER_CONTENT or SubscriberInterface.SUBSCRIBER_EVENT. The subscriber type can be ORed in order to return multiple types of subscribers.

compare - A Comparator for sorting, or null for no sorting.

Returns:

A List of SubscriberInterface objects.

Throws:

RemoteException - in the event of network error.

addContentSubscriber

public void addContentSubscriber(ContentSubscriberInterface subscriber)
                          throws RemoteException

Adds a content subscriber to this channel.

Specified by:

addContentSubscriber in interface ChannelInterface

Parameters:

subscriber - The content subscriber to add.

addEventSubscriber

public void addEventSubscriber(EventSubscriberInterface subscriber)
                        throws RemoteException

Adds an event subscriber to this channel.

Specified by:

addEventSubscriber in interface ChannelInterface

Parameters:

subscriber - The event subscriber to add.

Throws:

RemoteException - in the event of network error.

removeContentSubscriber

public void removeContentSubscriber(ContentSubscriberInterface subscriber)
                             throws RemoteException

Removes a content subscriber from this channel.

Specified by:

removeContentSubscriber in interface ChannelInterface

Parameters:

subscriber - The content subscriber to remove.

removeEventSubscriber

public void removeEventSubscriber(EventSubscriberInterface subscriber)
                           throws RemoteException

Removes an event subscriber from this channel.

Specified by:

removeEventSubscriber in interface ChannelInterface

Parameters:

subscriber - The event subscriber to remove.

Throws:

RemoteException - in the event of network error.

isGroupContentSubscription

public boolean isGroupContentSubscription(ContentSubscriberInterface subscriber)
                                   throws RemoteException

Determines if a user is subscribed to this channel through a group.

Specified by:

isGroupContentSubscription in interface ChannelInterface

Parameters:

subscriber - The subscriber

Returns:

true if a subscriber's group is subscribed to this channel

isGroupEventSubscription

public boolean isGroupEventSubscription(EventSubscriberInterface subscriber)
                                 throws RemoteException

Determines if a user is subscribed to this channel through a group as an event subscriber.

Specified by:

isGroupEventSubscription in interface ChannelInterface

Parameters:

subscriber - The event subscriber subscriber

Returns:

true if a subscriber's group is subscribed to this channel

Throws:

RemoteException - in the event of network error.

isContentSubscription

public boolean isContentSubscription(ContentSubscriberInterface subscriber)
                              throws RemoteException

Determines if a user is subscribed to this channel as a package subscriber.

Specified by:

isContentSubscription in interface ChannelInterface

Parameters:

subscriber - The subscriber

Returns:

true if user is subscribed, false otherwise

Throws:

RemoteException - in the event of network error.

isEventSubscription

public boolean isEventSubscription(EventSubscriberInterface subscriber)
                            throws RemoteException

Determines if a user is subscribed to this channel as an event subscriber.

Specified by:

isEventSubscription in interface ChannelInterface

Parameters:

subscriber - The subscriber

Returns:

true if user is subscribed, false otherwise

Throws:

RemoteException - in the event of network error.

subscriberNameList

public List subscriberNameList(int subscriberType)
                        throws RemoteException,
                               ServiceException

Return a List of subscriber names.

Specified by:

subscriberNameList in interface ChannelInterface

Parameters:

subscriberType - Identifies the type of subscriber to return information for. Valid subscriber types include SubscriberInterface.SUBSCRIBER_CONTENT or SubscriberInterface.SUBSCRIBER_EVENT. The subscriber type can be ORed in order to return names for multiple subscriber types.

Returns:

A List of Strings with the names of the subscribers to this channel.

Throws:

ServiceException - if a repository error occurs.

RemoteException - in the event of network error.

subscriberGroupsList

public List subscriberGroupsList(int subscriberType)
                          throws RemoteException

Returns a List of Group objects that are subscribed to this channel.

Specified by:

subscriberGroupsList in interface ChannelInterface

Parameters:

subscriberType - Identifies the type of subscriber to return information for. Valid subscriber types include SubscriberInterface.SUBSCRIBER_CONTENT or SubscriberInterface.SUBSCRIBER_EVENT. The subscriber type can be ORed in order to return groups for multiple subscriber types.

Returns:

a List of Group objects.

Throws:

RemoteException - in the event of network error.

addSubscriberGroup

public void addSubscriberGroup(GroupInterface group)
                        throws RemoteException,
                               ServiceException

Add a subscriber group to this channel.

Specified by:

addSubscriberGroup in interface ChannelInterface

Parameters:

group - The new subscriber group.

Throws:

RemoteException - in the event of a remote object failure.

ServiceException - if a repository error occurs.

removeSubscriberGroup

public void removeSubscriberGroup(GroupInterface group)
                           throws RemoteException,
                                  ServiceException

Remove a subscriber group from this channel.

Specified by:

removeSubscriberGroup in interface ChannelInterface

Parameters:

group - The group to unsubscribe.

Throws:

ServiceException - if a repository error occurs.

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 ChannelInterface

Returns:

The type of url, parent or collection.

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 ChannelInterface

Parameters:

type - The type of url, parent or collection.

packageList

public List packageList()
                 throws RemoteException

Returns an iteration of all the packages contained in this channel.

Specified by:

packageList in interface ChannelInterface

Returns:

A List of com.sas.services.publish.metadata.PackageInterface objects that were published to this channel.

Throws:

RemoteException - in the event of remote object failure.

packageList

public List packageList(Comparator compare)
                 throws RemoteException

Returns a sorted List of all the archives contained in this channel.

Specified by:

packageList in interface ChannelInterface

Parameters:

compare - A Comparator for sorting, or null for no sorting.

Returns:

A List of com.sas.services.publish.metadata.PackageInterface objects published to this channel.

Throws:

RemoteException - in the event of remote object failure.

getDefaultTransport

public int getDefaultTransport()
                        throws RemoteException

getDeliveryTransport

public int getDeliveryTransport()
                         throws RemoteException

Description copied from interface: ChannelInterface

Gets the default transport defined for this channel.

Specified by:

getDeliveryTransport in interface ChannelInterface

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

Returns:

The default transport defined as ChannelInterface.UNSUPPORTED_TRANSPORT, ChannelInterface.NO_TRANSPORT, ChannelInterface.ARCHIVE_TRANSPORT or ChannelInterface.WEBDAV_TRANSPORT.

Throws:

RemoteException - in the event of network error.

setDeliveryTransport

public void setDeliveryTransport(int transport)
                          throws RemoteException,
                                 IllegalArgumentException

Sets the delivery transport for this channel.

Specified by:

setDeliveryTransport in interface ChannelInterface

Parameters:

transport - The new delivery transport.

Throws:

RemoteException - in the event of a network error.

IllegalArgumentException - if an invalid transport is specified.

toString

public String toString()

Overrides:

toString in class RemoteObject

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 Metadata

Throws:

ServiceException - if a repository error occurs.

RemoteException - in the event of remote object failure.

setRepository

public void setRepository(RepositoryInterface repos)
                   throws IllegalStateException,
                          RemoteException

Description copied from interface: MetadataInterface

Set the repository that this item exists in.

Specified by:

setRepository in interface MetadataInterface

Overrides:

setRepository in class Metadata

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

Parameters:

repository - A handle to the repository for this object.

Throws:

IllegalStateException - If the repository has already been set.

RemoteException - if an error occurs

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