org.ow2.petals.microkernel.api.system
Interface SystemStateService


public interface SystemStateService

Allows to persist, update, delete and recover JBI artefacts.

Author:
Olivier Fabre - EBM WebSourcing, Roland Naudin - EBM WebSourcing

Field Summary
static String COMPONENT_LOGGER_NAME
           
 
Method Summary
 org.ow2.petals.systemstate.generated.Component createComponentStateHolder(String componentName, URL installUrl, String archiveName)
          Create a Component entry in the System State.
 org.ow2.petals.systemstate.generated.ServiceAssembly createServiceAssemblyStateHolder(String saName, URL installUrl, String archiveName)
          Create a ServiceAssembly entry in the System State.
 org.ow2.petals.systemstate.generated.SharedLibrary createSharedLibraryStateHolder(String slName, String version, URL installUrl, String archiveName)
          Create a SharedLibrary entry in the System State.
 org.ow2.petals.systemstate.generated.Component deleteComponentStateHolder(String componentName)
          Delete a Component entry from the System State.
 org.ow2.petals.systemstate.generated.ServiceAssembly deleteServiceAssemblyStateHolder(String saName)
          Delete a ServiceAssembly entry from the System State.
 org.ow2.petals.systemstate.generated.SharedLibrary deleteSharedLibraryStateHolder(String slName, String version)
          Delete a SharedLibrary entry from the System State.
 org.ow2.petals.systemstate.generated.Component getComponentStateHolder(String componentName)
          Get the Component entry from the System State.
 List<org.ow2.petals.systemstate.generated.Component> getComponentStateHolders()
          Get the Components entries from the System State.
 org.ow2.petals.systemstate.generated.ServiceAssembly getServiceAssemblyStateHolder(String saName)
          Get the ServiceAssembly entry from the System State.
 List<org.ow2.petals.systemstate.generated.ServiceAssembly> getServiceAssemblyStateHolders()
          Get the ServiceAssemblys entries from the System State.
 org.ow2.petals.systemstate.generated.SharedLibrary getSharedLibraryStateHolder(String slName, String version)
          Get the SharedLibrary entry from the System State.
 List<org.ow2.petals.systemstate.generated.SharedLibrary> getSharedLibraryStateHolders()
          Get the SharedLibrarys entries from the System State.
 List<org.ow2.petals.systemstate.generated.SharedLibrary> getSharedLibraryStateHolders(String slName)
          Get the SharedLibrarys entries from the System State matching the given name.
 boolean isComponentInstalled(String componentName)
          Check if the given component is already installed
 void updateComponentInstallationState(String componentName, String installState)
          Update the given component installation state.
 void updateComponentLifeCycleState(String componentName, String lifecycleState)
          Update the given component lifecycle state.
 void updateServiceAssemblyState(String saName, String lifecycleState)
          Update the given service assembly state.
 

Field Detail

COMPONENT_LOGGER_NAME

static final String COMPONENT_LOGGER_NAME
See Also:
Constant Field Values
Method Detail

createComponentStateHolder

org.ow2.petals.systemstate.generated.Component createComponentStateHolder(String componentName,
                                                                          URL installUrl,
                                                                          String archiveName)
                                                                          throws org.ow2.petals.systemstate.SystemStateException
Create a Component entry in the System State.

Parameters:
componentName -
installUrl -
archiveName -
Returns:
the created Component entry
Throws:
org.ow2.petals.systemstate.SystemStateException - failed to persist the new System State

createServiceAssemblyStateHolder

org.ow2.petals.systemstate.generated.ServiceAssembly createServiceAssemblyStateHolder(String saName,
                                                                                      URL installUrl,
                                                                                      String archiveName)
                                                                                      throws org.ow2.petals.systemstate.SystemStateException
Create a ServiceAssembly entry in the System State.

Parameters:
saName -
installUrl -
archiveName -
Returns:
the created ServiceAssembly
Throws:
org.ow2.petals.systemstate.SystemStateException - failed to persist the new System State

createSharedLibraryStateHolder

org.ow2.petals.systemstate.generated.SharedLibrary createSharedLibraryStateHolder(String slName,
                                                                                  String version,
                                                                                  URL installUrl,
                                                                                  String archiveName)
                                                                                  throws org.ow2.petals.systemstate.SystemStateException
Create a SharedLibrary entry in the System State.

Parameters:
slName -
installUrl -
archiveName -
Returns:
the created SharedLibrary
Throws:
org.ow2.petals.systemstate.SystemStateException - failed to persist the new System State

deleteComponentStateHolder

org.ow2.petals.systemstate.generated.Component deleteComponentStateHolder(String componentName)
                                                                          throws org.ow2.petals.systemstate.SystemStateException
Delete a Component entry from the System State.

Parameters:
componentName -
Returns:
the deleted entry or null if not found
Throws:
org.ow2.petals.systemstate.SystemStateException - failed to persist the new System State

deleteServiceAssemblyStateHolder

org.ow2.petals.systemstate.generated.ServiceAssembly deleteServiceAssemblyStateHolder(String saName)
                                                                                      throws org.ow2.petals.systemstate.SystemStateException
Delete a ServiceAssembly entry from the System State.

Parameters:
saName -
Returns:
the deleted entry or null if not found
Throws:
org.ow2.petals.systemstate.SystemStateException - failed to persist the new System State

deleteSharedLibraryStateHolder

org.ow2.petals.systemstate.generated.SharedLibrary deleteSharedLibraryStateHolder(String slName,
                                                                                  String version)
                                                                                  throws org.ow2.petals.systemstate.SystemStateException
Delete a SharedLibrary entry from the System State.

Parameters:
slName -
version -
Returns:
the deleted entry or null if not found
Throws:
org.ow2.petals.systemstate.SystemStateException - failed to persist the new System State

getComponentStateHolder

org.ow2.petals.systemstate.generated.Component getComponentStateHolder(String componentName)
Get the Component entry from the System State.

Parameters:
componentName -
Returns:
the Component entry or null if not found

getComponentStateHolders

List<org.ow2.petals.systemstate.generated.Component> getComponentStateHolders()
Get the Components entries from the System State.

Returns:
the list of Components entries

getServiceAssemblyStateHolder

org.ow2.petals.systemstate.generated.ServiceAssembly getServiceAssemblyStateHolder(String saName)
Get the ServiceAssembly entry from the System State.

Parameters:
saName -
Returns:
the ServiceAssembly entry or null if not found

getServiceAssemblyStateHolders

List<org.ow2.petals.systemstate.generated.ServiceAssembly> getServiceAssemblyStateHolders()
Get the ServiceAssemblys entries from the System State.

Returns:
the list of ServiceAssemblys entries

getSharedLibraryStateHolder

org.ow2.petals.systemstate.generated.SharedLibrary getSharedLibraryStateHolder(String slName,
                                                                               String version)
Get the SharedLibrary entry from the System State.

Parameters:
slName -
version -
Returns:
the SharedLibrary entry or null if not found

getSharedLibraryStateHolders

List<org.ow2.petals.systemstate.generated.SharedLibrary> getSharedLibraryStateHolders()
Get the SharedLibrarys entries from the System State.

Returns:
the list of SharedLibrarys entries

getSharedLibraryStateHolders

List<org.ow2.petals.systemstate.generated.SharedLibrary> getSharedLibraryStateHolders(String slName)
Get the SharedLibrarys entries from the System State matching the given name.

Parameters:
slName -
Returns:
the list of SharedLibrarys entries

isComponentInstalled

boolean isComponentInstalled(String componentName)
Check if the given component is already installed

Parameters:
componentName -
Returns:
true if already installed, false otherwise

updateComponentInstallationState

void updateComponentInstallationState(String componentName,
                                      String installState)
                                      throws org.ow2.petals.systemstate.SystemStateException
Update the given component installation state.

Parameters:
componentName -
installState -
Throws:
org.ow2.petals.systemstate.SystemStateException

updateComponentLifeCycleState

void updateComponentLifeCycleState(String componentName,
                                   String lifecycleState)
                                   throws org.ow2.petals.systemstate.SystemStateException
Update the given component lifecycle state.

Parameters:
componentName -
lifecycleState -
Throws:
org.ow2.petals.systemstate.SystemStateException

updateServiceAssemblyState

void updateServiceAssemblyState(String saName,
                                String lifecycleState)
                                throws org.ow2.petals.systemstate.SystemStateException
Update the given service assembly state.

Parameters:
saName -
lifecycleState -
Throws:
org.ow2.petals.systemstate.SystemStateException


Copyright © 2005-2015 Linagora. All Rights Reserved.