|
Oracle Virtual Desktop Infrastructure Java API Reference Release 3.3 E24174-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface VDIClient
Client web service interface.
Method Summary | |
---|---|
java.lang.String |
changePassword(java.lang.String newPassword) Changes the current logged in users password to newPassword . |
java.util.List<DesktopInfo> |
getAssignments() Returns a List of desktops and pool assigned to the user or token. |
java.util.List<Property> |
getInfo(java.util.List<Property> query, java.util.List<java.lang.String> requestedProps) Returns VDI system Property s based on client context specified in query. |
void |
logoff() Closes this web service HTTP session. |
void |
logon(java.lang.String user, java.lang.String password, java.lang.String token) Logs the specified user in to the web service. |
void |
resetDesktop(java.lang.String desktopId) Resets the desktop. |
DesktopInfo |
startDesktop(java.lang.String desktopId) Starts the specified desktop. |
DesktopInfo |
startDesktopFromPool(java.lang.String poolName) Starts and assigns a desktop in the specified pool. |
Method Detail |
---|
java.util.List<Property> getInfo(java.util.List<Property> query, java.util.List<java.lang.String> requestedProps) throws WebServiceClientException
Property
s based on client context specified in query.
query supports the following properties:
token
- Token ID of clientuser
- Username or ID of client
requestedProps supports the following property Strings:
DomainList
- Return list of domainsAuthentication
- Return authentication enabled stateScreenlock
- Return screen lock enabled stateAuthMethods
- Return supported authentication methodsRedirectFirstServer
- Should redirect to first serverVersion
- Return system versionUserName
- Return username associated with specified query tokenPreferredServerList
- Return list of preferred servers for userShowDomainList
- Should show domain listquery
- client context information for queryrequestedProps
- specific properties to query or null for allProperty
as requestedWebServiceClientException
void logon(java.lang.String user, java.lang.String password, java.lang.String token) throws WebServiceClientException
The user and password is authenticated against the directories configured within the system. An optional token can be specified.
user
- Username or ID known to the systempassword
- Password of the specified usertoken
- Optional token from client Sun Ray or OVDCWebServiceClientException
- if authentication fails, a password change is necessary or an error occursvoid logoff()
java.util.List<DesktopInfo> getAssignments() throws WebServiceClientException
Returns a list of desktops directly assigned to the user and any pools the user is assigned to.
DesktopInfo
objects representing desktop and pools assigned to the user or tokenWebServiceClientException
- if no desktops or pools are available or and error occursjava.lang.String changePassword(java.lang.String newPassword) throws WebServiceClientException
newPassword
.newPassword
- New password to be set for logged in userWebServiceClientException
- if an error occurs attempting to change the passwordDesktopInfo startDesktop(java.lang.String desktopId) throws WebServiceClientException
If the user or token already has an assigned desktop, the desktop will be started if needed, and the RDP connection end point and other information will be returned in DesktopInfo
.
desktopId
- ID of desktop to start for the user or tokenDesktopInfo
Object containing connection information for the desktopWebServiceClientException
- if no desktop is available or any other error occursDesktopInfo startDesktopFromPool(java.lang.String poolName) throws WebServiceClientException
If the user or token already has an assigned desktop, the desktop will be started if needed, and the RDP connection end point and other information will be returned in DesktopInfo
.
If the user or token doesn't have an existing assignment, one will be created if possible, the desktop will be started if needed and the RDP connection end point and other information will be returned in DesktopInfo
.
poolName
- Name of pool that contains a desktop to start for the user or tokenDesktopInfo
Object containing connection information for the desktopWebServiceClientException
- if no desktop is available or any other error occursvoid resetDesktop(java.lang.String desktopId) throws WebServiceClientException
Power cycles the desktop with the specified ID. This is equivalent to pressing the reset button on a physical PC.
desktopId
- of the desktop to reset.WebServiceClientException
- if desktop is not found or user doesn't have permission
|
Oracle Virtual Desktop Infrastructure Java API Reference Release 3.3 E24174-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |