public interface Desktop
Modifier and Type | Method and Description |
---|---|
void |
changeLoginPassword(char[] password,
char[] npassword)
Changes the password of the currently login user.
|
void |
changeLogoutPassword(String userCode,
char[] npassword)
Changes the password of the specified user when logout.
|
void |
changeMailAddress(char[] password,
String address)
Changes the mail address of the currently login user.
|
boolean |
checkPassword(char[] password)
Returns
true if login password equals supplied password. |
DdeTopic |
createDdeTopic(String topicName)
Creates and returns a new DDE Topic with the supplied name.
|
MailSender |
createMailSender()
Creates and returns a new mail message builder and sender.
|
void |
deleteObject(AccessLevel level,
ObjectType type,
String name)
Deletes an object with the specified access level, type and name.
|
String |
encodeCredentials(String userCode,
char[] password)
Returns a string with the encoding of supplied credentials.
|
Application |
getApplication()
Returns the
Application of the Desktop. |
String |
getAutoLoginParameters()
Returns the encoded parameters required for auto-login.
|
URL |
getCodebase()
Returns the codebase of the Desktop.
|
Compiler |
getCompiler()
Returns the expression compiler of the Desktop.
|
DesktopConfig |
getConfig()
Returns the configuration parameters of the Desktop.
|
File |
getHomeDirectory()
Returns the home directory of the Desktop.
|
ImageCache |
getImageCache()
Returns the
ImageCache of the Desktop. |
DesktopLicense |
getLicense()
Returns the license of the Desktop.
|
Map<String,LoginService> |
getLoginServices()
Returns an unmodifiable map with all defined login services.
|
Settings |
getLoginSettings()
Returns the login settings for the user.
|
Object |
getLoginState()
Returns the state of the login.
|
NetServerManager |
getNetServerManager()
Returns the Desktop
NetServerManager . |
Stage |
getPrimaryStage()
Returns the primary
Stage of the Desktop. |
URL |
getSecureCodebase()
Returns the secure codebase of the Desktop.
|
String |
getServerEnvironName()
Returns the environment name of the Application Server.
|
String |
getServerPageExtension()
Returns the file extension of a page of the Application Server.
|
long |
getServerTime()
Returns the time of the Application Server (milliseconds).
|
TimeZone |
getServerTimeZone()
Returns the time zone of the Application Server.
|
DesktopStation |
getStation()
Returns the station of the Desktop.
|
int |
getUniqueID()
Returns the unique identification of the Desktop.
|
DesktopUser |
getUser()
Returns the user of the Desktop.
|
String |
getVersion()
Returns the version string of the Desktop.
|
Level |
getWebServiceLoggerLevel()
Returns the logging level of web service invocations.
|
void |
initHttpSecurityHeaders(URLConnection urlconn)
Initialize the HTTP Security Headers of an
URLConnection . |
void |
initWebServicePort(Object port)
Initialize a web service port.
|
void |
initWebServicePort(Object port,
Service service,
URL codebase)
Initialize a web service port using supplied service and codebase.
|
void |
initWebServicePort(Object port,
URL endpoint)
Initialize a web service port using supplied endpoint.
|
boolean |
isLogin()
Returns
true if logged in (not in anonymous state). |
List<String> |
listObjectNames(AccessLevel level,
ObjectType type,
String prefix)
Returns a list of names of objects with access level, type and prefix.
|
void |
login(String userCode,
char[] password,
int profileCode)
Login using supplied user, password and profile information.
|
DesktopUser |
loginCheck(String userCode,
char[] password,
int profileCode)
Returns the user with supplied credentials and profile.
|
List<LoginProfile> |
loginProfiles(String userCode,
char[] password)
Returns an unmodifiable list with all profiles of specified user.
|
void |
logout(Object loginState)
Logout the current user saving the supplied login state.
|
Object |
readObject(AccessLevel level,
ObjectType type,
String name)
Reads an object with the specified access level, type and name.
|
void |
renameObject(AccessLevel level,
ObjectType type,
String name,
String newName)
Renames an object with the specified access level, type and name.
|
void |
setWebServiceLoggerLevel(Level level)
Changes the logging level of web service invocations.
|
void |
showDocument(String uri)
Opens the specified URI in a new browser window or tab.
|
boolean |
tryAutoLogin()
Attempts auto-login the Desktop using configuration parameters.
|
void |
writeObject(AccessLevel level,
ObjectType type,
String name,
Object object)
Writes an object with the specified access level, type and name.
|
String getVersion()
File getHomeDirectory()
int getUniqueID()
URL getCodebase()
URL getSecureCodebase()
DesktopLicense getLicense()
DesktopStation getStation()
DesktopUser getUser()
DesktopConfig getConfig()
Compiler getCompiler()
DdeTopic createDdeTopic(String topicName) throws Exception
topicName
- the name of the new DDE Topic.topicName
.NullPointerException
- if topicName
is null
.Exception
- if another error occurs.Application getApplication()
Application
of the Desktop.Application
of the Desktop.Stage getPrimaryStage()
Stage
of the Desktop.Stage
of the Desktop.ImageCache getImageCache()
ImageCache
of the Desktop.ImageCache
of the Desktop.void showDocument(String uri)
uri
- the URI of the web page that will be opened in a browser.NullPointerException
- if uri
is null
or empty.long getServerTime()
TimeZone getServerTimeZone()
String getServerEnvironName()
String getServerPageExtension()
Level getWebServiceLoggerLevel()
void setWebServiceLoggerLevel(Level level)
level
- the new logging level of web service invocations.NullPointerException
- if level
is null
.void initHttpSecurityHeaders(URLConnection urlconn)
URLConnection
.urlconn
- the URL Connection to be initialized.NullPointerException
- if urlconn
is null
.void initWebServicePort(Object port) throws Exception
port
- the web service port to initialize.NullPointerException
- if port
is null
.IllegalArgumentException
- if the port
is invalid.Exception
- if another error occurs.void initWebServicePort(Object port, URL endpoint) throws Exception
port
- the web service port to initialize.endpoint
- the endpoint of the web service port.NullPointerException
- if an argument is null
.IllegalArgumentException
- if the port
is invalid.Exception
- if another error occurs.void initWebServicePort(Object port, Service service, URL codebase) throws Exception
port
- the web service port to initialize.service
- the web service associatted with the port.codebase
- the codebase used to compute the port endpoint.NullPointerException
- if an argument is null
.IllegalArgumentException
- if the port
is invalid.Exception
- if another error occurs.NetServerManager getNetServerManager() throws Exception
NetServerManager
.NetServerManager
.IllegalStateException
- if not logged in.Exception
- if another error occurs.List<String> listObjectNames(AccessLevel level, ObjectType type, String prefix)
level
- the access level of the objects.type
- the type of the objects that will be listed.prefix
- the name prefix used to filter the returned names.NullPointerException
- if an argument is null
.Object readObject(AccessLevel level, ObjectType type, String name) throws Exception
level
- the access level of the object.type
- the type of the object.name
- the name of the object.null
if not found.NullPointerException
- if an argument is null
.Exception
- if another error occurs.void writeObject(AccessLevel level, ObjectType type, String name, Object object) throws Exception
level
- the access level of the object.type
- the type of the object.name
- the name of the object.object
- the object that will be saved.NullPointerException
- if an argument is null
.Exception
- if another error occurs.void renameObject(AccessLevel level, ObjectType type, String name, String newName)
level
- the access level of the object.type
- the type of the object.name
- the name of the object.newName
- the new name of the object.NullPointerException
- if an argument is null
.void deleteObject(AccessLevel level, ObjectType type, String name)
level
- the access level of the object.type
- the type of the object.name
- the name of the object.NullPointerException
- if an argument is null
.boolean isLogin()
true
if logged in (not in anonymous state).true
if logged in (not in anonymous state).Map<String,LoginService> getLoginServices() throws Exception
Exception
- if an error occurs.Settings getLoginSettings() throws Exception
Exception
- if an error occurs.Object getLoginState() throws Exception
Exception
- if an error occurs.String getAutoLoginParameters() throws Exception
Exception
- if an error occurs.boolean tryAutoLogin()
true
if the auto-login operation was successful.StationException
- if the desktop station is unusable.List<LoginProfile> loginProfiles(String userCode, char[] password)
userCode
- the identification of the user.password
- the plain-text password of the user.NullPointerException
- if an argument is null
.ExpiredException
- if the user password expired.DesktopUser loginCheck(String userCode, char[] password, int profileCode)
userCode
- the identification of the user.password
- the plain-text password of the user.profileCode
- the identification of a user profile.null
if user not found or invalid.NullPointerException
- if an argument is null
.IllegalArgumentException
- if an argument is invalid.void login(String userCode, char[] password, int profileCode)
userCode
- the identification of the user.password
- the plain-text password of the user.profileCode
- the identification of a user profile.NullPointerException
- if an argument is null
.IllegalArgumentException
- if an argument is invalid.IllegalStateException
- if the user is already login.ExpiredException
- if the user password expired.void logout(Object loginState) throws Exception
loginState
- state to be saved for next login (can be null).Exception
- if an error occurs.String encodeCredentials(String userCode, char[] password)
userCode
- the identification of the user.password
- the plain-text password of the user.NullPointerException
- if an argument is null
.IllegalArgumentException
- if an argument is invalid.boolean checkPassword(char[] password)
true
if login password equals supplied password.password
- the plain-text password to be checked.true
if login password equals supplied password.void changeLoginPassword(char[] password, char[] npassword) throws Exception
password
- the current password of the login user.npassword
- the new password of the login user.NullPointerException
- if an argument is null
.IllegalArgumentException
- if an argument is invalid.Exception
- if another error occurs.void changeLogoutPassword(String userCode, char[] npassword) throws Exception
userCode
- the identification of the user.npassword
- the new password of the login user.NullPointerException
- if an argument is null
.IllegalArgumentException
- if an argument is invalid.Exception
- if another error occurs.MailSender createMailSender() throws Exception
Exception
- if another error occurs.void changeMailAddress(char[] password, String address) throws Exception
password
- the password of the login user.address
- the new mail address of the user.NullPointerException
- if an argument is null
.IllegalArgumentException
- if an argument is invalid.Exception
- if another error occurs.Copyright © OBCOM INGENIERIA S.A. (Chile). All Rights Reserved.