Skip navigation links

Oracle Virtual Desktop Infrastructure Java API Reference
Release 3.5
E36505-01


com.sun.vda.client.ws.api
Interface VDIClient


public interface VDIClient

Client web service interface.


Method Summary
 java.lang.String changePassword(java.lang.String newPassword)
          Changes the current logged in user's 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 list 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

getInfo

java.util.List<Property> getInfo(java.util.List<Property> query,
                                 java.util.List<java.lang.String> requestedProps)
                                 throws WebServiceClientException
Returns VDI system Property list based on client context specified in query.

query supports the following properties:

token - Token ID of client
user - Username or ID of client

requestedProps supports the following property Strings:

DomainList - Return list of domains
Authentication - Return authentication enabled state
Screenlock - Return screen lock enabled state
AuthMethods - Return supported authentication methods
RedirectFirstServer - Should redirect to first server
Version - Return system version
UserName - Return username associated with specified query token
PreferredServerList - Return list of preferred servers for user
ShowDomainList - Should show domain list
vda.client.logout.always - Indicates whether or not clients should always log out on disconnection
Parameters:
query - client context information for query
requestedProps - specific properties to query or null for all
Returns:
Requested Property list
Throws:
WebServiceClientException

logon

void logon(java.lang.String user,
           java.lang.String password,
           java.lang.String token)
           throws WebServiceClientException
Logs the specified user in to the web service.

The user and password is authenticated against the directories configured within the system. An optional token can be specified.

Parameters:
user - Username or ID known to the system
password - Password of the specified user
token - Optional token from a Sun Ray client or an Oracle Virtual Desktop Client
Throws:
WebServiceClientException - if authentication fails, a password change is necessary or an error occurs

logoff

void logoff()
Closes this web service HTTP session.

getAssignments

java.util.List<DesktopInfo> getAssignments()
                                           throws WebServiceClientException
Returns a List of desktops and pool assigned to the user or token.

Returns a list of desktops directly assigned to the user and any pools the user is assigned to.

Returns:
List of DesktopInfo objects representing desktop and pools assigned to the user or token
Throws:
WebServiceClientException - if no desktops or pools are available or and error occurs

changePassword

java.lang.String changePassword(java.lang.String newPassword)
                                throws WebServiceClientException
Changes the current logged in user's password to newPassword.
Parameters:
newPassword - New password to be set for logged in user
Returns:
Success or error message
Throws:
WebServiceClientException - if an error occurs attempting to change the password

startDesktop

DesktopInfo startDesktop(java.lang.String desktopId)
                         throws WebServiceClientException
Starts the specified desktop.

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.

Parameters:
desktopId - ID of desktop to start for the user or token
Returns:
DesktopInfo Object containing connection information for the desktop
Throws:
WebServiceClientException - if no desktop is available or any other error occurs

startDesktopFromPool

DesktopInfo startDesktopFromPool(java.lang.String poolName)
                                 throws WebServiceClientException
Starts and assigns a desktop in the specified pool.

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.

Parameters:
poolName - Name of pool that contains a desktop to start for the user or token
Returns:
DesktopInfo Object containing connection information for the desktop
Throws:
WebServiceClientException - if no desktop is available or any other error occurs

resetDesktop

void resetDesktop(java.lang.String desktopId)
                  throws WebServiceClientException
Resets the desktop.

Power cycles the desktop with the specified ID. This is equivalent to pressing the reset button on a physical PC.

Parameters:
desktopId - of the desktop to reset.
Throws:
WebServiceClientException - if desktop is not found or user doesn't have permission

Skip navigation links

Oracle Virtual Desktop Infrastructure Java API Reference
Release 3.5
E36505-01


Copyright © 2011, 2013, Oracle and/or its affiliates. All rights reserved.