oracle.webcenter.portal.legacy

Interface ServicesAPI

public interface ServicesAPI

Interface to access Service related APIs enabling the examination of provisioned services as well as the ability to provision services on specific Portals.

Method Summary

Modifier and Type	Method and Description
void	copy(java.lang.String serviceId, java.lang.String srcPortalName, java.lang.String tgtPortalName, boolean copyAll) Copies a services from one portal to another, optionally including all of the service's contents.
java.util.List<oracle.webcenter.framework.service.Service>	getConfiguredServices() Gets the list of configured services.
java.util.List<java.lang.String>	getLazilyProvisionedServices() The list of services, identified by service id, which support lazy provisioning.
boolean	isMailService(java.lang.String serviceId) Returns true if serviceId corresponds to the mail service.
boolean	isProvisioned(java.lang.String serviceId, java.lang.String portalName) Returns the status of a Service's provisionment within a Portal.
void	provision(java.lang.String serviceId, java.lang.String portalName) Provisions a service for a specific Portal.
void	provisionMailService(java.lang.String target) Provisions the mail service on a separate thread.
void	unprovision(java.lang.String serviceId, java.lang.String portalName) Unprovisions a service for a specific Portal.

Method Detail

getConfiguredServices

java.util.List<oracle.webcenter.framework.service.Service> getConfiguredServices()

Gets the list of configured services.

Returns:

the configured services

isProvisioned

boolean isProvisioned(java.lang.String serviceId,
                      java.lang.String portalName)

Returns the status of a Service's provisionment within a Portal.

Parameters:

serviceId - The service Id to be checked.

portalName - The name of the Portal whose services are to be checked

Returns:

true if the service is provisioned otherwise false.

provision

void provision(java.lang.String serviceId,
               java.lang.String portalName)

Provisions a service for a specific Portal.

Parameters:

serviceId - The id of the service to provision.

portalName - The name of the Portal to have a service provisioned to it.

unprovision

void unprovision(java.lang.String serviceId,
                 java.lang.String portalName)

Unprovisions a service for a specific Portal.

Parameters:

serviceId - The id of the service to unprovision.

portalName - The name of the Portal to have a service provisioned to it.

copy

void copy(java.lang.String serviceId,
          java.lang.String srcPortalName,
          java.lang.String tgtPortalName,
          boolean copyAll)

Copies a services from one portal to another, optionally including all of the service's contents.

Parameters:

serviceId - the service to be copied.

srcPortalName - the source portal (scope) to be copied from.

tgtPortalName - the target portal (scope) to be copied to.

copyAll - true if the service should be requested to copy all of its contents, else the service is requested to copy its structure.

getLazilyProvisionedServices

java.util.List<java.lang.String> getLazilyProvisionedServices()

The list of services, identified by service id, which support lazy provisioning.

Returns:

a list of service ids for services which support lazy provisioning.

isMailService

boolean isMailService(java.lang.String serviceId)

Returns true if serviceId corresponds to the mail service.

Parameters:

serviceId - a service id.

Returns:

true if serviceId identifies mail service.

provisionMailService

void provisionMailService(java.lang.String target)

Provisions the mail service on a separate thread.

Parameters:

target - the target portal to provision the mail service for.