com.intel.gpe.clients.api
Interface TargetSystemManagementClient

All Superinterfaces:

ServiceClient, WSRFClient, WSRPClient

All Known Subinterfaces:

GPETargetSystemManagementClient

public interface TargetSystemManagementClient
extends WSRPClient

The client interface to target system management operations

Version:

$Id: TargetSystemManagementClient.java,v 1.11 2006/06/08 09:26:27 baklushin Exp $

Author:

Alexander Lukichev

Method Summary

void	addApplication(Application application, Incarnation incarnation) Add application to the list of applications supported by a target system
void	addRegistryUser(User user) Add user as a Registry to the list of users for a target system
void	addUser(User user) Add user to a list of users for a taget system
org.w3c.dom.Element	getTargetSystemConfiguration() Provide current configuration of target system
<UserType extends User> java.util.List<UserType>	getUsers() Get a list of users from a target system
void	removeApplication(java.lang.String appName, java.lang.String appVersion) Remove application from the list of applications supported by a target system
void	removeUser(User user) Remove user from a target system
void	updateUser(User user) Update user information

Methods inherited from interface com.intel.gpe.clients.api.WSRPClient

getMultipleResourceProperties, getResourceProperty, getResourcePropertyDocument, queryXPath10Properties

Method Detail

getUsers

<UserType extends User> java.util.List<UserType> getUsers()
                                               throws GPEInvalidResourcePropertyQNameException,
                                                      GPEResourceUnknownException,
                                                      GPEUnmarshallingException,
                                                      GPESecurityException,
                                                      GPEMiddlewareRemoteException,
                                                      GPEMiddlewareServiceException

Get a list of users from a target system

Returns:

list of users as an array

Throws:

GPEInvalidResourcePropertyQNameException - If target system does not provide User property

GPEResourceUnknownException - If WSRF-HE fails to find a resource with corresponding identifier

GPEUnmarshallingException - If something bad happens during convertation from XML to resource property object

GPESecurityException - If client fails to setup security

GPEMiddlewareRemoteException - If middleware throws an analogue of RemoreException

GPEMiddlewareServiceException - If middleware throws an analogue of ServiceException

addUser

void addUser(User user)
             throws GPEUserNotAddedException,
                    GPEResourceUnknownException,
                    GPECertificateProcessionException,
                    GPESecurityException,
                    GPEMiddlewareServiceException,
                    GPEMiddlewareRemoteException

Add user to a list of users for a taget system

Parameters:

user - user information

Throws:

GPEUserNotAddedException - If taget system refused to add a user

GPECertificateProcessionException - If client-side failed to obtain required information from certificate provided

GPEResourceUnknownException - If WSRF-HE fails to find a resource with corresponding identifier

GPESecurityException - If client fails to setup security

GPEMiddlewareRemoteException - If middleware throws an analogue of RemoreException

GPEMiddlewareServiceException - If middleware throws an analogue of ServiceException

addRegistryUser

void addRegistryUser(User user)
                     throws GPEUserNotAddedException,
                            GPEResourceUnknownException,
                            GPECertificateProcessionException,
                            GPESecurityException,
                            GPEMiddlewareServiceException,
                            GPEMiddlewareRemoteException

Add user as a Registry to the list of users for a target system

Parameters:

user - user information

Throws:

GPEUserNotAddedException - If taget system refused to add a user

GPECertificateProcessionException - If client-side failed to obtain required information from certificate provided

GPEResourceUnknownException - If WSRF-HE fails to find a resource with corresponding identifier

GPESecurityException - If client fails to setup security

GPEMiddlewareRemoteException - If middleware throws an analogue of RemoreException

GPEMiddlewareServiceException - If middleware throws an analogue of ServiceException

updateUser

void updateUser(User user)
                throws GPECertificateProcessionException,
                       GPEMiddlewareServiceException,
                       GPESecurityException,
                       GPEUserNotUpdatedException,
                       GPEResourceUnknownException,
                       GPEMiddlewareRemoteException

Update user information

Parameters:

user - user information

Throws:

GPEUserNotUpdatedException - If target system refused to update user information

GPECertificateProcessionException - If client-side failed to obtain required information from certificate provided

GPEResourceUnknownException - If WSRF-HE fails to find a resource with corresponding identifier

GPESecurityException - If client fails to setup security

GPEMiddlewareRemoteException - If middleware throws an analogue of RemoreException

GPEMiddlewareServiceException - If middleware throws an analogue of ServiceException

removeUser

void removeUser(User user)
                throws GPEMiddlewareServiceException,
                       GPESecurityException,
                       GPEUserNotRemovedException,
                       GPEResourceUnknownException,
                       GPEMiddlewareRemoteException

Remove user from a target system

Parameters:

user - user information

Throws:

GPEUserNotRemovedException - If target system refused to remove user

GPEResourceUnknownException - If WSRF-HE fails to find a resource with corresponding identifier

GPESecurityException - If client fails to setup security

GPEMiddlewareRemoteException - If middleware throws an analogue of RemoreException

GPEMiddlewareServiceException - If middleware throws an analogue of ServiceException

addApplication

void addApplication(Application application,
                    Incarnation incarnation)
                    throws GPEMiddlewareServiceException,
                           GPESecurityException,
                           GPEApplicationNotAddedException,
                           GPEResourceUnknownException,
                           GPEMiddlewareRemoteException

Add application to the list of applications supported by a target system

Parameters:

application - application data

incarnation - incarnation template for an application

Throws:

GPEApplicationNotAddedException - If target system refused to add this application

GPEResourceUnknownException - If WSRF-HE fails to find a resource with corresponding identifier

GPESecurityException - If client fails to setup security

GPEMiddlewareRemoteException - If middleware throws an analogue of RemoreException

GPEMiddlewareServiceException - If middleware throws an analogue of ServiceException

removeApplication

void removeApplication(java.lang.String appName,
                       java.lang.String appVersion)
                       throws GPEMiddlewareServiceException,
                              GPESecurityException,
                              GPEResourceUnknownException,
                              GPEApplicationNotRemovedException,
                              GPEMiddlewareRemoteException

Remove application from the list of applications supported by a target system

Parameters:

appName - application name

appVersion - application version

Throws:

GPEApplicationNotRemovedException - If target system refused to remove this application

GPEResourceUnknownException - If WSRF-HE fails to find a resource with corresponding identifier

GPESecurityException - If client fails to setup security

GPEMiddlewareRemoteException - If middleware throws an analogue of RemoreException

GPEMiddlewareServiceException - If middleware throws an analogue of ServiceException

getTargetSystemConfiguration

org.w3c.dom.Element getTargetSystemConfiguration()
                                                 throws GPEInvalidResourcePropertyQNameException,
                                                        GPEResourceUnknownException,
                                                        GPESecurityException,
                                                        GPEUnmarshallingException,
                                                        GPEMiddlewareRemoteException,
                                                        GPEMiddlewareServiceException

Provide current configuration of target system

Throws:

GPEInvalidResourcePropertyQNameException - If target system does not provide TSConfig property

GPEResourceUnknownException - If WSRF-HE fails to find a resource with corresponding identifier

GPESecurityException - If client fails to setup security

GPEUnmarshallingException - If something bad happens during convertation from XML to resource property object

GPEMiddlewareRemoteException - If middleware throws an analogue of RemoreException

GPEMiddlewareServiceException - If middleware throws an analogue of ServiceException