com.sapportals.wcm.repository.service

Interface IRepositoryServiceFactory

public interface IRepositoryServiceFactory

Defines an interface for a repository service factory. This factory creates instances of repository dependent services. It also provides access to repository independet services.

Copyright 2004 SAP AG

Method Summary

Collection	getAllRepositoryServices(IRepositoryManager repository) Get a list of all registered repository services for a given repository manager.
Collection	getAllRepositoryServices(IResource resource) Get all repository services for a given resources repository manager.
Collection	getAllServices() Returns a collection of all defined global services
IRepositoryService	getRepositoryService(IRepositoryManager repository, String servicetype) Returns a specific repository service instance for a given repository manager.
IRepositoryService	getRepositoryService(IResource resource, String servicetype) Get a specific service for a given resource.
IRepositoryService	getRepositoryService(String id) Deprecated. Use method with IRepositoryManager as additional parameter instead.
IService	getService(String serviceID) Retrieves a global service by a given ID.
boolean	isRepositoryServiceAvailable(IRepositoryManager repository, String servicetype) Checks if the service is avaible.
boolean	isRepositoryServiceAvailable(IResource resource, String servicetype) Checks if the service is avaible.

Method Detail

getAllRepositoryServices

public Collection getAllRepositoryServices(IRepositoryManager repository)
                                    throws ResourceException

Get a list of all registered repository services for a given repository manager.

Returns:

Collection of IRepositoryService references.

Throws:

ResourceException - If there was a problem while allocating the services.

getRepositoryService

public IRepositoryService getRepositoryService(IRepositoryManager repository,
                                               String servicetype)
                                        throws ResourceException

Returns a specific repository service instance for a given repository manager.

Parameters:

repository - A repository manager reference

servicetype - A service type constant

Returns:

A IRepositoryService reference.

Throws:

ResourceException - If there was a problem while allocating the service.

isRepositoryServiceAvailable

public boolean isRepositoryServiceAvailable(IRepositoryManager repository,
                                            String servicetype)
                                     throws ResourceException

Checks if the service is avaible.

Parameters:

repository - A repository manager reference

servicetype - A service type constant

Returns:

repositoryServiceAvailable

Throws:

ResourceException - If there was a problem while allocating the service.

getAllRepositoryServices

public Collection getAllRepositoryServices(IResource resource)
                                    throws ResourceException

Get all repository services for a given resources repository manager. Same as calling getAllRepositoryServices(IRepositoryManager repository) with the resources repository manager.

Returns:

A Collection of IRepositoryService s.

Throws:

ResourceException - If there was a problem while allocating the services.

getRepositoryService

public IRepositoryService getRepositoryService(IResource resource,
                                               String servicetype)
                                        throws ResourceException

Get a specific service for a given resource.

Parameters:

servicetype - A service type constant

Returns:

A IRepositoryService .

Throws:

ResourceException - If there was a problem while allocating the service.

isRepositoryServiceAvailable

public boolean isRepositoryServiceAvailable(IResource resource,
                                            String servicetype)
                                     throws ResourceException

Checks if the service is avaible.

Parameters:

servicetype - A service type constant

Returns:

repositoryServiceAvailable

Throws:

ResourceException - If there was a problem while allocating the service.

getRepositoryService

public IRepositoryService getRepositoryService(String id)
                                        throws ResourceException

Deprecated. Use method with IRepositoryManager as additional parameter instead.

Retrieves a repository service by a given ID.

Parameters:

id - The services ID

Returns:

A IRepositoryService .

Throws:

ResourceException - If there was a problem while allocating the service.

getService

public IService getService(String serviceID)
                    throws ResourceException

Retrieves a global service by a given ID.

Parameters:

serviceID - The service ID as specified in configuration.

Returns:

A reference to the global service

Throws:

ResourceException - Exception raised in failure situation

getAllServices

public Collection getAllServices()
                          throws ResourceException

Returns a collection of all defined global services

Returns:

A Collection with IService instances - empty collection if no global services are available

Throws:

ResourceException - Exception raised in failure situation