fr.liglab.adele.cilia

Interface AdminChain

All Known Subinterfaces:

CiliaAdminService

public interface AdminChain

Author:

Cilia Project Team

Method Summary

Methods

Modifier and Type	Method and Description
void	copyComponent(String chainId, String source, String destination) Copy the information of an existing component to another one.
void	createChain(String chain) Create a new mediation chain contained
void	createEmptyChain(String id) Create a new initial empty chain chain/
boolean	deleteChain(String id) Delete a mediation chain.
Chain	getChain(String id) Retrieve a mediation chain.
void	loadChain(String URI) Load a mediation chain specified on the given URI string.
void	replaceComponent(String chainId, String from, String to) Replace one component for another and copy his data.
boolean	updateChain(String id, String... instructions) It modifies the given mediation chain by using a set of reconfiguration instructions.

Method Detail

getChain

Chain getChain(String id)
               throws CiliaIllegalParameterException

Retrieve a mediation chain.

Parameters:

id - The ID of the chain to retrieve

Returns:

The required Chain, return null if chain does not exist.

Throws:

CiliaIllegalParameterException

createEmptyChain

void createEmptyChain(String id)
                      throws CiliaException

Create a new initial empty chain chain/

Parameters:

id - The ID of the new mediation chain.

Throws:

CiliaException - if the given chain id already exist.

createChain

void createChain(String chain)
                 throws CiliaException

Create a new mediation chain contained

Parameters:

chain -

Throws:

CiliaException

loadChain

void loadChain(String URI)
               throws CiliaException,
                      CiliaParserException

Load a mediation chain specified on the given URI string. The resource must be in XML format.

Parameters:

URI - The URI where the chain is located

Throws:

CiliaException - If Chain id exist.

CiliaParserException - If the XML containing the mediation chain is not well formed.

updateChain

boolean updateChain(String id,
                  String... instructions)
                    throws CiliaException

It modifies the given mediation chain by using a set of reconfiguration instructions.

Parameters:

id - The ID of the chain to modify

instructions - The set of instructions to which will modify the mediation chain.

Returns:

true if the reconfiguration is successful, false if the chain does not exist.

Throws:

CiliaException - if there is any error on the instructions.

copyComponent

void copyComponent(String chainId,
                 String source,
                 String destination)
                   throws CiliaException

Copy the information of an existing component to another one.

Parameters:

chainId - The chain Identification.

source - The id of the component source.

destination - The id of the component destination.

Throws:

CiliaException

replaceComponent

void replaceComponent(String chainId,
                    String from,
                    String to)
                      throws CiliaException

Replace one component for another and copy his data.

Parameters:

chainId - The chain to modify.

from - the original component.

to - The destination component

Throws:

CiliaException

deleteChain

boolean deleteChain(String id)
                    throws CiliaIllegalParameterException,
                           CiliaIllegalStateException,
                           BuilderException,
                           BuilderPerformerException

Delete a mediation chain.

Parameters:

id - The ID of the chain to be deleted

Returns:

true if chain is successful deleted, false if it does not exist.

Throws:

CiliaIllegalStateException

CiliaIllegalParameterException

BuilderException

BuilderPerformerException