|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
@StableMinor(version="4.1", sinceVersion="4.0") public interface IServiceInstanceManager
Manager Interface for Service Instance operations
Method Summary | |
---|---|
String |
add(SessionConfig sessionConfig,
ServiceInstanceConfig serviceInstanceConfig,
boolean fromDeserialization,
ITransaction transaction)
|
String |
add(SessionConfig sessionConfig,
ServiceInstanceConfig serviceInstanceConfig,
ITransaction transaction)
Add a service instance. |
void |
addOrUpdate(SessionConfig sessionConfig,
ServiceInstanceConfig serviceInstanceConfig,
boolean fromDeserialization,
ITransaction transaction)
|
void |
addOrUpdate(SessionConfig sessionConfig,
ServiceInstanceConfig serviceInstanceConfig,
ITransaction transaction)
Add or Update a Service Instance, depending on its previous existence. |
void |
clearServiceInstanceCache(SessionConfig sessionConfig,
String serviceInstanceId,
ITransaction transaction)
Remove the object cache entries for the specificed Service Instance also clearing it's ACL cache. |
void |
delete(SessionConfig sessionConfig,
String serviceInstanceId,
boolean force,
ITransaction transaction)
Delete a service instance. |
void |
deleteCustomProperties(SessionConfig sessionConfig,
String serviceInstanceId,
ITransaction transaction)
Deletes all service instance´s custom properties |
void |
deleteCustomProperty(SessionConfig sessionConfig,
String serviceInstanceId,
String name,
ITransaction transaction)
Deletes a service instance custom property |
String |
deserialize(SessionConfig sessionConfig,
DeserializationConfig deserializationConfig,
Node serviceInstanceNode,
ITransaction transaction)
|
void |
deserializeCustomProperties(SessionConfig sessionConfig,
DeserializationConfig deserializationConfig,
Node serviceInstanceCustomPropertiesNode,
ITransaction transaction)
Deserialize custom properties from a XML node into a service instance. |
String |
deserializeDependency(SessionConfig sessionConfig,
DeserializationConfig deserializationConfig,
Node serviceInstanceDependencyNode,
ITransaction transaction)
Deserializes the given dependency |
ServiceInstanceConfig |
findServiceInstanceThroughChannelTree(SessionConfig sessionConfig,
String channelId,
String serviceId,
ITransaction transaction)
Searches for a service instance |
ServiceInstanceConfig |
get(String serviceInstanceId,
ITransaction transaction)
Get the configuration of the service instance. |
Map<String,String> |
getCustomProperties(SessionConfig sessionConfig,
String serviceInstanceId,
ITransaction transaction)
Gets all the custom properties of a specified service instance. |
String |
getCustomProperty(SessionConfig sessionConfig,
String serviceInstanceId,
String name,
ITransaction transaction)
Returns the specified custom property. |
ServiceInstanceDependencyConfig |
getDependency(String serviceInstanceDependencyId,
ITransaction transaction)
|
Collection<String> |
getDependencyIdsByServiceInstanceId(SessionConfig sessionConfig,
String serviceInstanceId,
ITransaction transaction)
Returns the service instance ids that the given service instance id depends on |
Collection<String> |
getDependentServiceInstanceIds(SessionConfig sessionConfig,
String serviceInstanceId,
ITransaction transaction)
|
Collection<ServiceInstanceConfig> |
getDependentServiceInstances(SessionConfig sessionConfig,
String serviceInstanceId,
ITransaction transaction)
Returns the service instances that are dependent on the specified service instance. |
Collection<String> |
getIds(SessionConfig sessionConfig,
ITransaction transaction)
Get the ids of all services instances |
Collection<String> |
getIdsByChannelId(SessionConfig sessionConfig,
String channelId,
ITransaction transaction)
Get the ids of the services instances by passing the channel id. |
Collection<String> |
getIdsByChannelTree(SessionConfig sessionConfig,
String rootChannelId,
ITransaction transaction)
Get the ids of the services instances of all the channel tree by passing the tree's root channel id. |
Collection<String> |
getIdsByServiceId(SessionConfig sessionConfig,
String serviceId,
ITransaction transaction)
Get the ids of the services instances by passing the service id. |
ServiceInstanceConfig |
getServiceInstanceByDependency(SessionConfig sessionConfig,
String serviceInstanceId,
String dependencyType,
ITransaction transaction)
Get the service instance the given service instance depends on by the given dependency type. |
void |
serialize(SessionConfig sessionConfig,
String serviceInstanceId,
OutputStream outputStream,
ITransaction transaction)
|
void |
serializeCustomProperties(SessionConfig sessionConfig,
String serviceInstanceId,
OutputStream outputStream,
ITransaction transaction)
Serializes the custom properties of a service instance into the specified outputstream. |
void |
serializeDependencies(SessionConfig sessionConfig,
String serviceInstanceId,
OutputStream outputStream,
ITransaction transaction)
Serializes the dependencies of a service instance |
void |
setCustomProperties(SessionConfig sessionConfig,
String serviceInstanceId,
Map<String,String> propertiesTable,
ITransaction transaction)
|
void |
setCustomProperty(SessionConfig sessionConfig,
String serviceInstanceId,
String name,
String value,
ITransaction transaction)
Set a custom property for the given service instance. |
void |
setServiceInstanceDependency(ServiceInstanceDependencyConfig serviceInstanceDependencyConfig,
ITransaction transaction)
Sets the given service instance dependency. |
void |
update(SessionConfig sessionConfig,
ServiceInstanceConfig serviceInstanceConfig,
ITransaction transaction)
Update a service instance. |
Methods inherited from interface lumis.portal.serialization.operation.IConfigDeleter |
---|
deleteConfig |
Methods inherited from interface lumis.portal.serialization.operation.IConfigKeyChecker |
---|
keyExists |
Method Detail |
---|
void addOrUpdate(SessionConfig sessionConfig, ServiceInstanceConfig serviceInstanceConfig, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- serviceInstanceConfig
- transaction
-
ManagerException
PortalException
ServiceInstanceConfig get(String serviceInstanceId, ITransaction transaction) throws ManagerException, PortalException
serviceInstanceId
- transaction
-
ManagerException
PortalException
ServiceInstanceConfig findServiceInstanceThroughChannelTree(SessionConfig sessionConfig, String channelId, String serviceId, ITransaction transaction) throws PortalException
sessionConfig
- channelId
- serviceId
- transaction
-
PortalException
String add(SessionConfig sessionConfig, ServiceInstanceConfig serviceInstanceConfig, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- serviceInstanceConfig
- transaction
-
ManagerException
PortalException
void update(SessionConfig sessionConfig, ServiceInstanceConfig serviceInstanceConfig, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- serviceInstanceConfig
- transaction
-
ManagerException
PortalException
void delete(SessionConfig sessionConfig, String serviceInstanceId, boolean force, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- serviceInstanceId
- force
- TODOtransaction
-
ManagerException
PortalException
Collection<String> getIds(SessionConfig sessionConfig, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- channelId
- transaction
-
ManagerException
PortalException
Collection<String> getIdsByChannelId(SessionConfig sessionConfig, String channelId, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- channelId
- transaction
-
ManagerException
PortalException
Collection<String> getIdsByChannelTree(SessionConfig sessionConfig, String rootChannelId, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- rootChannelId
- transaction
-
ManagerException
PortalException
Collection<String> getIdsByServiceId(SessionConfig sessionConfig, String serviceId, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- serviceId
- transaction
-
ManagerException
PortalException
void setCustomProperty(SessionConfig sessionConfig, String serviceInstanceId, String name, String value, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- serviceInstanceId
- name
- value
- transaction
-
ManagerException
PortalException
String getCustomProperty(SessionConfig sessionConfig, String serviceInstanceId, String name, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- serviceInstanceId
- name
- transaction
-
ManagerException
PortalException
void deleteCustomProperty(SessionConfig sessionConfig, String serviceInstanceId, String name, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- serviceInstanceId
- name
- transaction
-
ManagerException
PortalException
void deleteCustomProperties(SessionConfig sessionConfig, String serviceInstanceId, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- serviceInstanceId
- transaction
-
ManagerException
PortalException
void serialize(SessionConfig sessionConfig, String serviceInstanceId, OutputStream outputStream, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- serviceInstanceId
- outputStream
- transaction
-
ManagerException
PortalException
String deserialize(SessionConfig sessionConfig, DeserializationConfig deserializationConfig, Node serviceInstanceNode, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- deserializationConfig
- serviceInstanceNode
- transaction
-
ManagerException
PortalException
ServiceInstanceConfig getServiceInstanceByDependency(SessionConfig sessionConfig, String serviceInstanceId, String dependencyType, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- current session informationserviceInstanceId
- the id of the service instance that depends on the returned service instance.dependencyType
- the type of dependency.transaction
- the transaction for persistence access.
ManagerException
PortalException
void setServiceInstanceDependency(ServiceInstanceDependencyConfig serviceInstanceDependencyConfig, ITransaction transaction) throws PortalException
serviceInstanceDependencyConfig
- the information about the dependency to be set.transaction
- the transaction for persistence access.
PortalException
void serializeDependencies(SessionConfig sessionConfig, String serviceInstanceId, OutputStream outputStream, ITransaction transaction) throws PortalException
sessionConfig
- serviceInstanceId
- outputStream
- transaction
-
PortalException
Collection<String> getDependencyIdsByServiceInstanceId(SessionConfig sessionConfig, String serviceInstanceId, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- serviceInstanceId
- transaction
-
ManagerException
PortalException
Collection<ServiceInstanceConfig> getDependentServiceInstances(SessionConfig sessionConfig, String serviceInstanceId, ITransaction transaction) throws PortalException
sessionConfig
- the user session information.serviceInstanceId
- the id of the service instance the returned service instances depend on.transaction
- the transaction for persistence access.
PortalException
String deserializeDependency(SessionConfig sessionConfig, DeserializationConfig deserializationConfig, Node serviceInstanceDependencyNode, ITransaction transaction) throws PortalException
sessionConfig
- deserializationConfig
- serviceInstanceDependencyNode
- transaction
-
PortalException
Map<String,String> getCustomProperties(SessionConfig sessionConfig, String serviceInstanceId, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- serviceInstanceId
- transaction
-
ManagerException
PortalException
void serializeCustomProperties(SessionConfig sessionConfig, String serviceInstanceId, OutputStream outputStream, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- serviceInstanceId
- outputStream
- transaction
-
ManagerException
PortalException
void deserializeCustomProperties(SessionConfig sessionConfig, DeserializationConfig deserializationConfig, Node serviceInstanceCustomPropertiesNode, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- deserializationConfig
- serviceInstanceCustomPropertiesNode
- transaction
-
ManagerException
PortalException
void clearServiceInstanceCache(SessionConfig sessionConfig, String serviceInstanceId, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- serviceInstanceId
- transaction
-
ManagerException
PortalException
ServiceInstanceDependencyConfig getDependency(String serviceInstanceDependencyId, ITransaction transaction) throws PortalException
PortalException
Collection<String> getDependentServiceInstanceIds(SessionConfig sessionConfig, String serviceInstanceId, ITransaction transaction) throws PortalException
PortalException
void setCustomProperties(SessionConfig sessionConfig, String serviceInstanceId, Map<String,String> propertiesTable, ITransaction transaction) throws ManagerException, PortalException
ManagerException
PortalException
void addOrUpdate(SessionConfig sessionConfig, ServiceInstanceConfig serviceInstanceConfig, boolean fromDeserialization, ITransaction transaction) throws ManagerException, PortalException
ManagerException
PortalException
String add(SessionConfig sessionConfig, ServiceInstanceConfig serviceInstanceConfig, boolean fromDeserialization, ITransaction transaction) throws PortalException
PortalException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |