|
SAP NetWeaver 7.30 SP01 KMC | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.sapportals.wcm.repository.service.AbstractRepositoryService
com.sapportals.wcm.service.wastebasket.WastebasketService
public class WastebasketService
Wastebasket Service.
Copyright (c) SAP AG 2002-2004
| Nested Class Summary |
|---|
| Nested classes/interfaces inherited from class com.sapportals.wcm.repository.service.AbstractRepositoryService |
|---|
AbstractRepositoryService.CONFIG_ATTRIBUTE_NAME |
| Field Summary |
|---|
| Fields inherited from class com.sapportals.wcm.repository.service.AbstractRepositoryService |
|---|
config, description, id, PARAMETER_ACTION, PARAMETER_FALSE, PARAMETER_IS_GLOBAL, PARAMETER_LOCATION, PARAMETER_POPUP, PARAMETER_PREFIX, PARAMETER_REPOSITORY, PARAMETER_RESOURCE, PARAMETER_SERVICE, PARAMETER_TRUE, properties, stateHandler |
| Constructor Summary | |
|---|---|
WastebasketService()
This constructor is only to be called by the J2EE environment at startup. |
|
| Method Summary | |
|---|---|
protected void |
addRepositoryAssignment(IRepositoryManager mgr)
Called by the framework if a new repository with services is added or the service was added to the list of an existing repository. |
boolean |
canRestore(IResource resource)
Indicates if the service is able to restore the given resource, i.e. if the resource is a link located in a user's global wastebasket pointing to a resource in that user's local wastebasket. |
com.sapportals.wcm.util.uri.RID |
delete(IResource resource)
Deletes the given resource by storing it in the user's local wastebasket. |
String |
getDescription()
Returns a description for this service. |
com.sapportals.wcm.util.uri.RID |
getGlobalWastebasketRID(IResource resource)
Returns the RID to a user's global wastebasket. |
com.sapportals.wcm.util.uri.RID |
getGlobalWastebasketRID(IResourceContext context)
Returns the RID to a user's global wastebasket. |
static IWastebasketService |
getInstance()
Returns the instance of this class that was last created. |
com.sapportals.wcm.util.uri.RID |
getLocalWastebasketRID(IResource resource)
Returns the RID to a user's local wastebasket. |
String |
getServiceType()
Get the service's service type, as defined in IWcmConfig. |
boolean |
hasWastebasket(IResource resource)
This method decides if the resource should be moved into the wastebasket or not |
void |
reconfigure(IConfiguration configuration)
Passes the new configuration data to the component. |
protected void |
removeRepositoryAssignment(IRepositoryManager mgr)
Called by the framework if a repository is removed from the configuration or the service is removed from the list. |
com.sapportals.wcm.util.uri.RID |
restore(IResource resource,
boolean overwrite)
Restores the given resource to it's original location and returns the RID of the restored resource. |
protected void |
startUpImpl(Collection repositoryManagers)
The implementation must overwrite this method if it has initial startup handling to do (acquire resources, open connections to remote systems, etc). |
| Methods inherited from class com.sapportals.wcm.repository.service.AbstractRepositoryService |
|---|
acceptServletCall, configure, convertConfigData, convertConfigToProperties, convertConfigToProperties, convertStatus, createPropertyList, getCreationDate, getDescription, getID, getInstanceType, getLastConfigurationException, getLastReconfigurationDate, getName, getNextAutoRestartDate, getProperties, getStartupException, getState, notify, retrieveMonitorData, shutDown, shutDownImpl, start, startUp, stop |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Methods inherited from interface com.sapportals.wcm.repository.service.IRepositoryService |
|---|
acceptServletCall, getDescription, getID |
| Constructor Detail |
|---|
public WastebasketService()
| Method Detail |
|---|
public static IWastebasketService getInstance()
public String getDescription()
IRepositoryService
getDescription in interface IRepositoryServicegetDescription in class AbstractRepositoryService
public com.sapportals.wcm.util.uri.RID getGlobalWastebasketRID(IResource resource)
throws com.sapportals.wcm.WcmException
IWastebasketService
getGlobalWastebasketRID in interface IWastebasketServicecom.sapportals.wcm.WcmException
public com.sapportals.wcm.util.uri.RID getGlobalWastebasketRID(IResourceContext context)
throws com.sapportals.wcm.WcmException
IWastebasketService
getGlobalWastebasketRID in interface IWastebasketServicecom.sapportals.wcm.WcmException
public com.sapportals.wcm.util.uri.RID getLocalWastebasketRID(IResource resource)
throws com.sapportals.wcm.WcmException
IWastebasketService
getLocalWastebasketRID in interface IWastebasketServicecom.sapportals.wcm.WcmExceptionIWastebasketService.hasWastebasket(IResource)
public boolean canRestore(IResource resource)
throws com.sapportals.wcm.WcmException
IWastebasketServiceIWastebasketService.restore(IResource, boolean) to succeed. But it might be used to
decide if a UI command should be rendered or not.
canRestore in interface IWastebasketServicecom.sapportals.wcm.WcmException
public com.sapportals.wcm.util.uri.RID delete(IResource resource)
throws com.sapportals.wcm.WcmException
IWastebasketServiceIWastebasketService.restore(IResource, boolean) method
to have the original resource restored.
delete in interface IWastebasketServiceresource - The resource to be deleted
null, if the resource was deleted permanently.
com.sapportals.wcm.WcmException
public com.sapportals.wcm.util.uri.RID restore(IResource resource,
boolean overwrite)
throws NameAlreadyExistsException,
com.sapportals.wcm.WcmException
IWastebasketService
restore in interface IWastebasketServiceNameAlreadyExistsException - It there exists a resource with the original RID
and parameter overwrite is false.
com.sapportals.wcm.WcmException
public boolean hasWastebasket(IResource resource)
throws com.sapportals.wcm.WcmException
hasWastebasket in interface IWastebasketServicecom.sapportals.wcm.WcmExceptionpublic String getServiceType()
IRepositoryService
getServiceType in interface IRepositoryService
protected void addRepositoryAssignment(IRepositoryManager mgr)
throws ServiceNotAvailableException
AbstractRepositoryService
addRepositoryAssignment in class AbstractRepositoryServicemgr - The repository manager instance that this service was assigned
to in configuration.
ServiceNotAvailableException - If the service cannot be assigned
to the repository.
protected void removeRepositoryAssignment(IRepositoryManager mgr)
throws com.sapportals.wcm.WcmException
AbstractRepositoryService
removeRepositoryAssignment in class AbstractRepositoryServicemgr - TBD: Description of the incoming method parameter
com.sapportals.wcm.WcmException - Exception raised in failure situation
public void reconfigure(IConfiguration configuration)
throws ConfigurationException
IReconfigurable
reconfigure in interface IReconfigurableconfiguration - The new configuration data.
ConfigurationException - Exception raised in failure situation
protected void startUpImpl(Collection repositoryManagers)
throws ConfigurationException,
StartupException,
ServiceNotAvailableException
AbstractRepositoryServiceIStartable interface of the CRT this
method will be called only once. It will be called on systen start up or
when a new instance of this component is added to the configuration.
startUpImpl in class AbstractRepositoryServicerepositoryManagers - A collection of repository manager instances that
this services is attached to via configuration. Usually a service
implementation will register for certain resource events at the
repository's event broker.
ConfigurationException - Exception raised in failure situation
StartupException - Exception raised in failure situation
ServiceNotAvailableException - Exception raised in failure
situation| Access Rights |
|---|
| SC | DC | Public Part | ACH |
|---|---|---|---|
[sap.com] KMC-WPC
|
[sap.com] tc/kmc/wpc/wpcfacade
|
api
|
EP-PIN-WPC-WCM
|
[sap.com] KMC-CM
|
[sap.com] tc/km/frwk
|
api
|
EP-KM-CM
|
|
SAP NetWeaver 7.30 SP01 KMC | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||