com.prosyst.mprm.backend.rpc

Interface BackendRPCService

public interface BackendRPCService

Allows synchronous RPC based communication between services running on the different hosts of a mPRM system. This interface is available as an OSGi service on every backend host of the mPRM system.

Method Summary

Modifier and Type	Method and Description
RemoteReference	getContextMultiHostReference(java.lang.String context, java.lang.String service, java.lang.String filter, java.lang.Class userClass) Returns remote reference to a all hosts belonging to the management servers, whcih manage part of the supplied tree context.
RemoteReference	getContextMultiRoleReference(java.lang.String context, java.lang.String service, java.lang.String filter, java.lang.Class userClass) Returns remote reference to a set of service instances.
RemoteReference	getMultiHostReference(java.lang.String[] hostRoles, java.lang.String service, java.lang.String filter, java.lang.Class userClass) Returns remote reference to a set of service instances.
RemoteReference	getMultiRoleReference(java.lang.String[] hostRoles, java.lang.String service, java.lang.String filter, java.lang.Class userClass) Returns remote reference to a set of service instances.
RemoteReference	getUniHostReference(java.lang.String hostId, java.lang.String service, java.lang.String filter, java.lang.Class userClass) Returns remote reference to a single service instance registered on particular mPRM host.
RemoteReference	getUniRoleReference(java.lang.String hostRole, java.lang.String service, java.lang.String filter, java.lang.Class userClass) Returns remote reference to a single service instance running of some of the hosts with a given role.

Method Detail

getUniHostReference

RemoteReference getUniHostReference(java.lang.String hostId,
                                    java.lang.String service,
                                    java.lang.String filter,
                                    java.lang.Class userClass)
                             throws RPCException

Returns remote reference to a single service instance registered on particular mPRM host. The host may be the local host as well.

Parameters:

hostId - the Id of the backend host

service - the class name of the service

filter - LDAP filter for searching the service. Can be null.

userClass - The class loader of this class will be used for loading the result objects of the service methods. If the parameter is null then default Class.forName will be used.

Returns:

RemoteReference object which allows invoking methods of the remote service.

Throws:

RPCException

getUniRoleReference

RemoteReference getUniRoleReference(java.lang.String hostRole,
                                    java.lang.String service,
                                    java.lang.String filter,
                                    java.lang.Class userClass)
                             throws RPCException

Returns remote reference to a single service instance running of some of the hosts with a given role. The RPC service will choose the actual host (if there are more than one host which have the supplied role). If the host becomes unavailable while the reference if is alive the RPC service will switch to another host with the same role if there is such. The switching is transparent to to application.

Parameters:

hostRole - the role of the backend host. Can be one of Role.CC, Role.MS, Role.RAS, or id of particular Management Server.

service - the class name of the service

filter - LDAP filter for searching the service. Can be null.

userClass - The class loader of this class will be used for loading the result objects of the service methods. If the parameter null then default Class.forName will be used.

Returns:

RemoteReference object which allows invoking methods of the remote services.

Throws:

RPCException

getMultiRoleReference

RemoteReference getMultiRoleReference(java.lang.String[] hostRoles,
                                      java.lang.String service,
                                      java.lang.String filter,
                                      java.lang.Class userClass)
                               throws RPCException

Returns remote reference to a set of service instances. The set contains one service instance for every supplied role. The RPC service will choose the actual host for every role (if there are more than one host which have the supplied role). If some of the hosts becomes unavailable while the reference if is alive the RPC service will switch to another host with the same role if there is such. The switching is transparent to the application. Invoking method on this reference will make respective method calls to all referenced services.

Parameters:

hostRoles - array of the target backend host roles. Elements of the array can be one of Role.CC, Role.MS, Role.RAS, or id of particular Management Server. Supplying Role.MS means that all management servers will be included.

service - the class name of the service

filter - LDAP filter for searching the service. Can be null.

userClass - The class loader of this class will be used for loading the result objects of the service methods. If the parameter null then default Class.forName will be used.

Returns:

RemoteReference object which allows invoking methods of the remote services.

Throws:

RPCException

getMultiHostReference

RemoteReference getMultiHostReference(java.lang.String[] hostRoles,
                                      java.lang.String service,
                                      java.lang.String filter,
                                      java.lang.Class userClass)
                               throws RPCException

Returns remote reference to a set of service instances. The set contains the relevant services of all hosts with the supplied role. Invoking method on this reference whill make respective method calls to all referenced services.

Parameters:

hostRoles - array of the target backend host roles. Elements of the array can be one of Role.CC, Role.MS, Role.RAS, or id of particular Management Server. Supplying Role.MS means that all management servers will be included.

service - the class name of the service

filter - LDAP filter for searching the service. Can be null.

userClass - The class loader of this class will be used for loading the result objects of the service methods. If the parameter null then default Class.forName will be used.

Returns:

RemoteReference object which allows invoking methods of the remote services.

Throws:

RPCException

getContextMultiRoleReference

RemoteReference getContextMultiRoleReference(java.lang.String context,
                                             java.lang.String service,
                                             java.lang.String filter,
                                             java.lang.Class userClass)
                                      throws RPCException

Returns remote reference to a set of service instances. The set contains one service instance of every management server which manages part of the supplied tree context. The RPC service will choose the actual host for every role (if there are more than one host which have the supplied role). If some of the hosts becomes unavailable while the reference if is alive the RPC service will switch to another host with the same role if there is such. The switching is transparent to the application. Invoking method on this reference whill make respective method calls to all referenced services.

Parameters:

context - the three path.

service - the class name of the service

filter - LDAP filter for searching the service. Can be null.

userClass - The class loader of this class will be used for loading the result objects of the service methods. If the parameter null then default Class.forName will be used.

Returns:

RemoteReference object which allows invoking methods of the remote services.

Throws:

RPCException

getContextMultiHostReference

RemoteReference getContextMultiHostReference(java.lang.String context,
                                             java.lang.String service,
                                             java.lang.String filter,
                                             java.lang.Class userClass)
                                      throws RPCException

Returns remote reference to a all hosts belonging to the management servers, whcih manage part of the supplied tree context. Invoking method on this reference whill make respective method calls to all referenced services.

Parameters:

context - the three path.

service - the class name of the service

filter - LDAP filter for searching the service. Can be null.

userClass - The class loader of this class will be used for loading the result objects of the service methods. If the parameter null then default Class.forName will be used.

Returns:

RemoteReference object which allows invoking methods of the remote services.

Throws:

RPCException