|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Client
The interface provides a mechanism to control one session with EGO.
A client can either be registered or unregistered. Unregistered clients can do information queries, such as: (i) host information, (ii) consumer information, (iii) registered client lookup. Registered clients have additional functionalities such as: (1) resource allocation (2) container execution (3) others can look up the client via VEM.
Method Summary | |
---|---|
Allocation |
allocate(AllocRequest req,
AllocationCallbackHandler handler)
This operation is used by an EGO client to make a request for resources. |
Allocation[] |
getAllocations()
Get allocations of client. |
ClusterAdmin |
getClusterAdmin()
Get admin of cluster. |
Connection |
getConn()
Get connection. |
ConsumerAdmin |
getConsumerAdmin()
Get admin of consumer. |
ConsumerPlan |
getConsumerPlan(java.lang.String consumerName,
java.lang.String resourceGroupName)
Get Consumer Plan for the given consumer and resource group. |
java.lang.String |
getDescription()
Get description of client. |
ClientInfoProvider |
getInfoProvider()
Get information provider. |
java.lang.String |
getLocation()
Get location of client. |
java.lang.String |
getName()
Get name of client. |
Service |
getService(java.lang.String servicename,
ServiceCallbackHandler handler)
Get an existing service. |
UserAdmin |
getUserAdmin()
Get admin of user. |
java.lang.String |
getUserName()
Get name of user. |
void |
logoff()
Logs off EGO and removes credential. |
java.lang.String |
logon(java.lang.String cred)
Logs on to EGO by credential. |
java.lang.String |
logon(java.lang.String username,
java.lang.String passwd)
Logs on to EGO by using name of user and password. |
java.lang.String |
refreshCredential()
Refresh credential. |
void |
register(ClientCallbackHandler handler)
Registers the client with EGO master. |
void |
reRegister()
reRegister to EGO through WSG, Usually happens after WSG failover; |
void |
setPlanCacheExpiryTime(long seconds)
Set the expiry time (in seconds) of the Consumer Plan cache. |
void |
unregister()
Unregister the client with EGO master. |
void |
unsubscribeService(Service service)
Unsubscribe a service. |
Method Detail |
---|
java.lang.String logon(java.lang.String username, java.lang.String passwd) throws EGOException, javax.xml.stream.XMLStreamException, org.apache.xmlbeans.XmlException
username
- : specifies name of user.passwd
- : specifies password of user.
EGOException.
EGOException
javax.xml.stream.XMLStreamException
org.apache.xmlbeans.XmlException
java.lang.String logon(java.lang.String cred) throws EGOException, javax.xml.stream.XMLStreamException, org.apache.xmlbeans.XmlException
cred
- : specifies credential of user.
EGOException
javax.xml.stream.XMLStreamException
org.apache.xmlbeans.XmlException
void logoff() throws EGOException
EGOException
void register(ClientCallbackHandler handler) throws EGOException, java.net.UnknownHostException
handler
- : one ClientCallbackHandler object that is implemented by users.
EGOException,
- UnknownHostException.
EGOException
java.net.UnknownHostException
void unregister() throws EGOException
EGOException.
EGOException
Allocation allocate(AllocRequest req, AllocationCallbackHandler handler) throws EGOException
req
- : specifies a description of the requested allocation.handler
- : one AllocationCallbackHandler object that is implemented by users.
EGOException.
EGOException
Service getService(java.lang.String servicename, ServiceCallbackHandler handler) throws EGOException, java.net.UnknownHostException
servicename
- : specifies name of service.handler
- : one ServiceCallbackHandler object that is implemented by users.
EGOException.
EGOException
java.net.UnknownHostException
void unsubscribeService(Service service) throws EGOException
service
-
EGOException
java.lang.String getName()
java.lang.String getDescription()
java.lang.String getLocation() throws EGOException
EGOException
java.lang.String refreshCredential() throws EGOException, org.apache.xmlbeans.XmlException, javax.xml.stream.XMLStreamException
EGOException
org.apache.xmlbeans.XmlException
javax.xml.stream.XMLStreamException
java.lang.String getUserName()
ClusterAdmin getClusterAdmin() throws EGOException
EGOException
ConsumerAdmin getConsumerAdmin() throws EGOException
EGOException
UserAdmin getUserAdmin() throws EGOException
EGOException
ClientInfoProvider getInfoProvider() throws EGOException
EGOException
Allocation[] getAllocations()
ConsumerPlan getConsumerPlan(java.lang.String consumerName, java.lang.String resourceGroupName)
void setPlanCacheExpiryTime(long seconds)
seconds
- Connection getConn()
void reRegister() throws EGOException, java.net.UnknownHostException
EGOException
java.net.UnknownHostException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |