LifecycleBean
- a bean that can be used to manage a lifecycle configuration.
Please note that a lifecycle configuration can be modified
only if it is not currently being used.public interface ILifecycleManagementService<LifecycleBean>
Modifier and Type | Method and Description |
---|---|
boolean |
createLifecycle(String configuration)
Method to create a new lifecycle configuration.
|
boolean |
deleteLifecycle(String name)
Method to delete an existing lifecycle configuration.
|
LifecycleBean |
getLifecycleBean(String name)
Method to obtain a configuration bean for the given lifecycle.
|
String |
getLifecycleConfiguration(String name)
Method to obtain the lifecycle configuration of the given lifecycle.
|
String |
getLifecycleConfigurationVersion(String name)
Method to retrieve the version of the defined lifecycle configuration
|
String[] |
getLifecycleList()
Method to obtain a list of currently configured lifecycles.
|
String |
getLifecyclesCollectionLocation()
Method to obtain the location on the repository where lifecycle configurations are stored.
|
boolean |
isLifecycleNameInUse(String name)
Method to determine whether the lifecycle configuration by the given name is currently being
used.
|
boolean |
parseConfiguration(String configuration)
Method to parse the given lifecycle configuration XML and generate a lifecycle configuration
bean.
|
void |
setLifecyclesCollectionLocation(String location)
Method to set the location on the repository where lifecycle configurations are stored.
|
boolean |
updateLifecycle(String oldName,
String configuration)
Method to update an existing lifecycle configuration.
|
String getLifecyclesCollectionLocation() throws Exception
Exception
- if the operation failed.void setLifecyclesCollectionLocation(String location) throws Exception
location
- the location on the repository where lifecycle configurations are stored.Exception
- if the operation failed.String[] getLifecycleList() throws Exception
Exception
- if the operation failed.LifecycleBean getLifecycleBean(String name) throws Exception
name
- the name of the lifecycle configuration.Exception
- if the operation failed.String getLifecycleConfiguration(String name) throws Exception
name
- the name of the lifecycle configuration.Exception
- if the operation failed.boolean createLifecycle(String configuration) throws Exception
configuration
- the string configuration. The name of the lifecycle will be determined
from the provided configuration.Exception
- if the operation failed due to an unexpected error.boolean updateLifecycle(String oldName, String configuration) throws Exception
oldName
- the name of the existing lifecycle configuration.configuration
- the string configuration containing the updated configuration. if the
new lifecycle configuration has a new name, the old lifecycle configuration
will be deleted and a new one will be added. If the names were the same, the
existing configuration will be updated instead.Exception
- if the operation failed due to an unexpected error.boolean deleteLifecycle(String name) throws Exception
name
- the name of the existing lifecycle configuration to be deleted.Exception
- if the operation failed due to an unexpected error.boolean isLifecycleNameInUse(String name) throws Exception
name
- the name of an existing lifecycle configuration.Exception
- if the operation failed.boolean parseConfiguration(String configuration) throws Exception
configuration
- the configuration of the lifecycle in XML.Exception
- if the operation failed.String getLifecycleConfigurationVersion(String name) throws Exception
name
- the name of the lifecycle resource.Exception
- if the operation failed.Copyright © 2023 WSO2. All Rights Reserved.