|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface WcmSyndicationService
WcmSyndicationService enables access to control syndication between Syndicator
and
Subscriber
.
To ensure that the service is available at runtime, the below line must be added to the services.properties file (<WPS profile home>\PortalServer\config\config\services.properties),
com.ibm.workplace.wcm.api.WcmSyndicationService = com.ibm.workplace.wcm.api.WcmSyndicationServiceImpl
Here is an example of how to retrieve the WcmSyndicationService
:
try { // Construct and inital Context InitialContext ctx = new InitialContext(); // Retrieve WcmSyndicationService using JNDI name WcmSyndicationService syndicationService = (WcmSyndicationService) ctx.lookup("portal:service/wcm/WcmSyndicationService"); } catch (NamingException ne) { System.out.print("Naming Exception: " + ne); }
Field Summary | |
---|---|
static java.lang.String |
JNDI_NAME
JNDI name of this service |
Method Summary | |
---|---|
Subscriber |
getSubscriberByName(Workspace workspace,
java.lang.String subscriberName)
Returns the Subscriber with the specified name, or
null if a Subscriber with that name
does not exist or the caller does not have access |
java.util.Iterator<Subscriber> |
getSubscribers(Workspace workspace)
Returns an iterator of all Subscriber objects visible
to the user of the Workspace . |
Syndicator |
getSyndicatorByName(Workspace workspace,
java.lang.String syndicatorName)
Returns the Syndicator with the specified name, or
null if a Syndicator with that name
does not exist or the caller does not have access |
java.util.Iterator<Syndicator> |
getSyndicators(Workspace workspace)
Returns an iterator of all Syndicator objects visible
to the user of the Workspace . |
Field Detail |
---|
static final java.lang.String JNDI_NAME
Method Detail |
---|
java.util.Iterator<Syndicator> getSyndicators(Workspace workspace)
Syndicator
objects visible
to the user of the Workspace
.
workspace
- the workspace
Syndicator
objectsSyndicator getSyndicatorByName(Workspace workspace, java.lang.String syndicatorName)
Syndicator
with the specified name, or
null
if a Syndicator
with that name
does not exist or the caller does not have access
workspace
- the workspacesyndicatorName
- the name of the Syndicator
to
retrieve
Syndicator
object representing the syndicator
with the given name, or null
if it does not exist.java.util.Iterator<Subscriber> getSubscribers(Workspace workspace)
Subscriber
objects visible
to the user of the Workspace
.
workspace
- the workspace
Subscriber
objectsSubscriber getSubscriberByName(Workspace workspace, java.lang.String subscriberName)
Subscriber
with the specified name, or
null
if a Subscriber
with that name
does not exist or the caller does not have access
workspace
- the workspacesubscriberName
- the name of the Subscriber
to
retrieve
Subscriber
object representing the subscriber
with the given name, or null
if it does not exist.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |