org.kie.server.controller.api

Interface KieServerControllerAdmin

public interface KieServerControllerAdmin

KieServer controller administration that deals with management tasks of the controller assets - kie server instances.

Method Summary

Methods

Modifier and Type	Method and Description
KieServerInstance	addKieServerInstance(org.kie.server.api.model.KieServerInfo kieServerInfo) Add new KieServer described as KieServerInfo (which is minimal set of information).
org.kie.server.api.model.KieContainerResource	createContainer(String id, String containerId, org.kie.server.api.model.KieContainerResource container) Creates container within given kie server(s)
void	deleteContainer(String id, String containerId) Deletes given container from kie server(s)
org.kie.server.api.model.KieContainerResource	getContainer(String id, String containerId) Returns given container from kie server(s)
KieServerInstance	getKieServerInstance(String identifier) Returns details of given KieServerInstance
List<KieServerInstance>	listKieServerInstances() Returns all managed KieServerInstance by this controller
KieServerInstance	removeKieServerInstance(String identifier) Removes defined KieServerInstance identified by identifier making it not being managed any more.
void	startContainer(String id, String containerId) Starts container within given kie server(s)
void	stopContainer(String id, String containerId) Starts container within given kie server(s)

Method Detail

addKieServerInstance

KieServerInstance addKieServerInstance(org.kie.server.api.model.KieServerInfo kieServerInfo)
                                       throws KieServerControllerException

Add new KieServer described as KieServerInfo (which is minimal set of information). This operation does not require actual KieServerInstance to be accessible but is more for making the controller aware of server(s) that will be representing this instance.

Parameters:

kieServerInfo - - minimal set of information to create KieServerInstance on controller

Returns:

representation of newly created KieServerInstance

Throws:

KieServerControllerException - thrown in case KieServerInstance is already created with given id

removeKieServerInstance

KieServerInstance removeKieServerInstance(String identifier)
                                          throws KieServerControllerException

Removes defined KieServerInstance identified by identifier making it not being managed any more. Does not have any impact on running servers besides they will be notified about being unmanaged so they will not attempt to connect to the controller

Parameters:

identifier - unique identifier of KieServerInstance

Returns:

removed definition of the KieServerInstance

Throws:

KieServerControllerException - thrown in case there is no such KieServerInstance with given identifier

listKieServerInstances

List<KieServerInstance> listKieServerInstances()

Returns all managed KieServerInstance by this controller

Returns:

list of all known KieServerInstances

getKieServerInstance

KieServerInstance getKieServerInstance(String identifier)
                                       throws KieServerControllerException

Returns details of given KieServerInstance

Parameters:

identifier - unique identifier of KieServerInstance

Returns:

details of KieServerInstance

Throws:

KieServerControllerException - thrown in case there is no such KieServerInstance with given identifier

createContainer

org.kie.server.api.model.KieContainerResource createContainer(String id,
                                                            String containerId,
                                                            org.kie.server.api.model.KieContainerResource container)

Creates container within given kie server(s)

Parameters:

id - kie server identifier

containerId - container identifier

container - KieContainerResource instance representing the actual container

Returns:

deleteContainer

void deleteContainer(String id,
                   String containerId)

Deletes given container from kie server(s)

Parameters:

id - kie server identifier

containerId - container identifier

getContainer

org.kie.server.api.model.KieContainerResource getContainer(String id,
                                                         String containerId)

Returns given container from kie server(s)

Parameters:

id - kie server identifier

containerId - container identifier

startContainer

void startContainer(String id,
                  String containerId)

Starts container within given kie server(s)

Parameters:

id - kie server identifier

containerId - container identifier

stopContainer

void stopContainer(String id,
                 String containerId)

Starts container within given kie server(s)

Parameters:

id - kie server identifier

containerId - container identifier