oracle.mobile.admin

Class MobileResourceManager

java.lang.Object

oracle.mobile.admin.MobileResourceManager

public class MobileResourceManager
extends java.lang.Object

The MobileResourceManager class is for administrative uses. It is thread-safe and it provides an array of administrative APIs that can be used to manage users, groups, applications, etc. This class is a replacement of the ResourceManager class, which has been deprecated as the APIs in ResourceManager are not thread-safe.

Constructor Summary

Constructors

Constructor and Description
MobileResourceManager(java.lang.String adminUser, java.lang.String adminPwd, java.lang.String adminURL) Initialize a MobileResourcManager object.

Method Summary

Methods

Modifier and Type	Method and Description
void	addUsersToGroup(java.lang.String groupName, java.util.Vector users) Add users to the given user group.
void	addUserToGroup(java.lang.String groupName, java.lang.String userName) Add one user to the given user group.
boolean	clearPassword(java.lang.String userName) Set password as null for an existing Mobile Server user to make user external.
void	closeConnection() End the Mobile Server administrative session.
void	commitTransaction() Commit the admin tasks in the current active session.
boolean	createExternalUser(java.lang.String userName, java.lang.String fullName, java.lang.String privilege) Create a Mobile Server user whose identification will be authenticated externally.
boolean	createGroup(java.lang.String groupName) Create a new Mobile Server user group.
boolean	createUser(java.lang.String userName, java.lang.String password, java.lang.String fullName, java.lang.String privilege) Create a new Mobile Server user.
void	dropApplication(java.lang.String virtualPath) Drop the named existing application.
void	dropGroup(java.lang.String groupName) Remove the named user group.
void	dropUser(java.lang.String userName) Remove a Mobile Server user.
java.lang.String	getApplicationClasspath(java.lang.String vp) Return the classpath of an application.
java.lang.String	getApplicationDefaultPage(java.lang.String vp) Return the default page of an application.
java.lang.String	getApplicationDescription(java.lang.String virtualPath) Return the description of an existing application.
java.lang.String	getApplicationIcon(java.lang.String vp) Return the icon of an applicaiton.
java.lang.String	getApplicationName(java.lang.String virtualPath) Return the name of an existing application.
java.lang.String	getApplicationPublication(java.lang.String vp) Return the publication associated with an application.
java.sql.Timestamp	getApplicationPublishedTime(java.lang.String virtualPath) Return the time an application was published.
java.lang.String	getApplicationRepositoryDirectory(java.lang.String vp) Return the repository directory of an application.
java.util.Enumeration	getApplicationUsers(java.lang.String virtualPath) Return an enumeration of the users associated with an application.
int	getDBConnections(java.lang.String virtualPath) Return the number of database connections for an existing application.
boolean	getDBConnectionSharing(java.lang.String virtualPath) Return the database connection sharing setting for an application.
java.lang.String	getDBUser(java.lang.String virtualPath) Return the database username for an existing application.
java.lang.String	getDSN(java.lang.String vp) Return the DSN of an application.
java.lang.String	getFullName(java.lang.String userName) Return the fullname information of an existing Mobile Server user.
boolean	getGroupAccess(java.lang.String virtualPath, java.lang.String groupName) Return application access for the user group.
boolean	getGroupRoleAccess(java.lang.String virtualPath, java.lang.String groupName, java.lang.String role) Return the group access with certain role for an application.
boolean	getGroupUserAccess(java.lang.String virtualPath, java.lang.String groupName, java.lang.String userName) This will check if an user belongs to a group and if that group has access to an application.
java.lang.String	getPrivilege(java.lang.String userName) Return the privilege of an existing Mobile Server user.
java.lang.String	getPublication(java.lang.String virtualPath) Return the name of the Consolidator publication associated with an application.
java.lang.String	getPublicationItemName(java.lang.String snapshot, java.lang.String appVP) This is a link between MobileResourceManager API and Consolidator API.
java.lang.String	getSnapshotTemplate(java.lang.String snapshot, java.lang.String appVP) Return the snapshot template string.
java.lang.String	getTemplateVariable(java.lang.String virtualPath, java.lang.String userName, java.lang.String varName) Return the value of an application snapshot template variable for one user.
java.util.Hashtable	getTemplateVariables(java.lang.String virtualPath, java.lang.String userName) Return the values of all the application snapshots template variables for one user.
boolean	getUserAccess(java.lang.String virtualPath, java.lang.String userName) Return application access for the user at the user level.
java.util.Vector	getUserGroupList(java.lang.String userName) Return a vector of id of the groups that an user has access.
java.util.Vector	getUserGroupNameList(java.lang.String userName) Return a vector of groups names that a user has access to.
java.util.Vector	getUserPublications(java.lang.String userName, java.lang.String platform) Return a vector of publications associated with a user.
boolean	getUserRoleAccess(java.lang.String virtualPath, java.lang.String userName, java.lang.String role) Return the user access for an application with certain role.
boolean	hasAccess(java.lang.String virtualPath, java.lang.String userName) Return application access for the user at the user level.
void	isAPI(boolean flag) Mobile Server can have a dependency on servlet.jar.
boolean	isServerSuspended() * Return the status of Mobile Server - suspended (single user) or * running in regular mode
java.util.Vector	listApplications(java.lang.String appnamePattern) List all the Mobile Server applications that match the namePattern.
java.util.Vector	listApplicationsByVP(java.lang.String vpPattern) List applications whose virtual path matches the supplied virtual path pattern.
java.util.Vector	listGroupRoles(java.lang.String virtualPath, java.lang.String groupName) List the roles a group has for an application.
java.util.Vector	listGroups(java.lang.String namePattern) List groups whose name matches the pattern.
java.util.Vector	listRoles(java.lang.String virtualPath) List the roles that are associated with an existing application.
java.util.Vector	listSnapshots(java.lang.String virtualPath) List the snapshots associated with an existing application.
java.util.Vector	listTemplateVariables(java.lang.String virtualPath) Lists the name of the all the snapshot template variables for an application on one platform.
java.util.Vector	listUserApplicationNames(java.lang.String userName) List all the applicatons that the user have access to.
java.util.Vector	listUserApplications(java.lang.String userName) List all the applicatons that the user have access to.
java.util.Vector	listUserRoles(java.lang.String virtualPath, java.lang.String userName) List the roles a user has for an applicaiton.
java.util.Vector	listUsers(java.lang.String namePattern) Find users whose username matches the name pattern.
java.util.Vector	listUsersInGroup(java.lang.String groupName) Return all the users in a user group.
void	mobileDisableUser(java.lang.String userName) Remove the entry for this user from Mobile Server.
boolean	mobileEnableUser(java.lang.String userName, java.lang.String privilege) Mobile Enable an IAS user residing in OID.
void	publishApplication(java.io.File jarFile, java.lang.String username, java.lang.String password, java.lang.String url, boolean isPublicApplication, boolean overwrite) Publish an application jar file.
void	removeUserFromGroup(java.lang.String groupName, java.lang.String userName) Removed a user from the given user group.
void	removeUsersFromGroup(java.lang.String groupName, java.util.Vector users) Remove users from the given user group.
void	resumeServer() * Resume Mobile Server and put it in back in Multi user mode
void	rollbackTransaction() Rollback the admin tasks in the current active session.
void	setApplicationClasspath(java.lang.String vp, java.lang.String cp) Set the classpath of an application.
void	setApplicationDefaultPage(java.lang.String vp, java.lang.String defaultPage) Set the default page of an application.
void	setApplicationDescription(java.lang.String virtualPath, java.lang.String description) Set the description for an existing application.
void	setApplicationIcon(java.lang.String vp, java.lang.String icon) Set the icon of an application.
void	setApplicationName(java.lang.String virtualPath, java.lang.String appname) Rename an existing application.
void	setApplicationPublication(java.lang.String vp, java.lang.String pubName) Associate the Consolidator publication of an application.
void	setApplicationPublishedTime(java.lang.String virtualPath) Set application publish time with the current time.
void	setDBConnections(java.lang.String virtualPath, int connections) Set the number of database connections for an existing application.
void	setDBConnectionSharing(java.lang.String virtualPath, boolean sharing) Enable/disable the database connection sharing for an existing application.
void	setDBUser(java.lang.String virtualPath, java.lang.String dbUser, java.lang.String dbPwd) Set the Database User property of an existing application.
void	setFullName(java.lang.String userName, java.lang.String fullname) Set the full name information for an existing Mobile Server user.
void	setGroupAccess(java.lang.String virtualPath, java.lang.String groupName, boolean access) Set application access for a group.
void	setGroupRoleAccess(java.lang.String virtualPath, java.lang.String groupName, java.lang.String role, boolean access) Set Group access with a role.
void	setGroupRoleAccess(java.lang.String virtualPath, java.lang.String groupName, java.util.Vector roles, boolean access) Grant or revoke application role for the group.
void	setGroupUserAccess(java.lang.String virtualPath, java.lang.String groupName, java.lang.String userName, boolean access) This method assigns finer grain user access to the application in a group level.
boolean	setPassword(java.lang.String userName, java.lang.String newpwd) Set password for an existing Mobile Server user.
void	setPrivilege(java.lang.String userName, java.lang.String privilege) Set the privilege for an existing Mobile Server user.
void	setTemplateVariable(java.lang.String virtualPath, java.lang.String userName, java.lang.String name, java.lang.String value) Set a snapshot template variable value for a particular user.
void	setTemplateVariables(java.lang.String virtualPath, java.lang.String userName, java.util.Hashtable nameValuePairs) Set snapshot template variables for a particular user.
void	setUserAccess(java.lang.String virtualPath, java.lang.String userName, boolean access) Sets application access for the user.
void	setUserCompleteRefresh(java.lang.String userName, java.lang.String platform) Set complete refresh on the given platform next time the user do a sync.
void	setUserRoleAccess(java.lang.String virtualPath, java.lang.String userName, java.lang.String role, boolean access) Grant or revoke application role for the user.
void	setUserRoleAccess(java.lang.String virtualPath, java.lang.String userName, java.util.Vector roles, boolean access) Grant or revoke application role for the user.
void	setUsersAccess(java.lang.String virtualPath, java.lang.String[] userName) Set access of an application for an array of users.
void	suspendServer(oracle.lite.web.WTGUser user) * Suspend Mobile Server and put it in Single user mode.
int	validateExternalUser(java.lang.String user, java.lang.String displayName)
int	validateUser(java.lang.String user, java.lang.String pwd, java.lang.String displayName)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MobileResourceManager

public MobileResourceManager(java.lang.String adminUser,
                     java.lang.String adminPwd,
                     java.lang.String adminURL)
                      throws ResException

Initialize a MobileResourcManager object.

Parameters:

adminUser - the username of the MobileAdmin schema.

adminPwd - the password of the MobileAdmin schema.

adminURL - the jdbc url of the database which contains the MobileAdmin schema.

Throws:

ResException

See Also:

MobileResourceManager(Connection conn)

Method Detail

addUsersToGroup

public void addUsersToGroup(java.lang.String groupName,
                   java.util.Vector users)
                     throws ResException

Add users to the given user group. Please note that both the group and the users need to be created beforehand.

Parameters:

groupName - the name of an existing user group. No action will be taken if the group does not exist.

users - a vector of existing user names that will be added to the group.

Throws:

ResException

addUserToGroup

public void addUserToGroup(java.lang.String groupName,
                  java.lang.String userName)
                    throws ResException

Add one user to the given user group. Please note that both the group and the user need to be created beforehand

Parameters:

groupName - the name of an existing user group. This method does nothing if the group does not exist.

userName - the name of an existing user.

Throws:

ResException

clearPassword

public boolean clearPassword(java.lang.String userName)
                      throws ResException

Set password as null for an existing Mobile Server user to make user external.

Parameters:

userName - the username of an existing Mobile Server user. No action will be taken if the user does not exist.

Returns:

true if password is cleared successfully otherwise false.

Throws:

ResException

closeConnection

public void closeConnection()

End the Mobile Server administrative session.

commitTransaction

public void commitTransaction()

Commit the admin tasks in the current active session.

createExternalUser

public boolean createExternalUser(java.lang.String userName,
                         java.lang.String fullName,
                         java.lang.String privilege)
                           throws ResException

Create a Mobile Server user whose identification will be authenticated externally.

Parameters:

userName - name of the new Mobile Server user Please note that it should not be the same of an existing user or group.

fullName - user's real name

privilege - the Mobile Server user privilege. The value can be one of the following: "O" for publishing an application. "U" for connecting to Mobile Server as an user. "A" for administrating the Mobile Server. "M" for Member user. NULL stands for none privilege.

Returns:

true after create a new user successfully. false if a user or group of that name already exists.

Throws:

ResException

createGroup

public boolean createGroup(java.lang.String groupName)

Create a new Mobile Server user group.

Parameters:

groupName - the name of the new Mobile Server user group. It should not have the same name as an existing user or group.

Returns:

true after create a new user group successfully. false if a group or user of that name already exists.

createUser

public boolean createUser(java.lang.String userName,
                 java.lang.String password,
                 java.lang.String fullName,
                 java.lang.String privilege)
                   throws ResException

Create a new Mobile Server user. No action will be taken if a user or group of the same name already exists.

Parameters:

userName - the name of the new Mobile Server user. Please note that it should not be the name of an existing user or group.

password - the clear text password for the new Mobile Server user.

fullName - user's real name

privilege - the Mobile Server user privilege. The value can be one of the following: "O" for publishing an application. "U" for connecting to Mobile Server as an user. "A" for administrating the Mobile Server. "M" for Member user. NULL stands for none privilege.

Returns:

true after create a new user successfully. false if a user or a group of that name already exists or username or password are not according to specification

Throws:

ResException

dropApplication

public void dropApplication(java.lang.String virtualPath)

Drop the named existing application.

Parameters:

virtualPath - the virtual path of an existing application. Please note that the virtual path is the unique identifier of an application.

dropGroup

public void dropGroup(java.lang.String groupName)

Remove the named user group. It will not remove users in the group.

Parameters:

groupName - the name of a Mobile Server user group.

dropUser

public void dropUser(java.lang.String userName)
              throws ResException

Remove a Mobile Server user.

Parameters:

userName - the username of the user

Throws:

ResException

getApplicationClasspath

public java.lang.String getApplicationClasspath(java.lang.String vp)

Return the classpath of an application.

Parameters:

vp - the virtual path of the application.

Returns:

the classpath of an application.

getApplicationDefaultPage

public java.lang.String getApplicationDefaultPage(java.lang.String vp)

Return the default page of an application.

Parameters:

vp - the virtual path of the application.

Returns:

the default page of an application.

getApplicationDescription

public java.lang.String getApplicationDescription(java.lang.String virtualPath)

Return the description of an existing application.

Parameters:

virtualPath - the virtual path of an existing application. Please note that the virtual path is the unique identifier of an application.

Returns:

description the description of the application.

getApplicationIcon

public java.lang.String getApplicationIcon(java.lang.String vp)

Return the icon of an applicaiton.

Parameters:

vp - the virtual path of the application.

Returns:

the icon of an applicaiton.

getApplicationName

public java.lang.String getApplicationName(java.lang.String virtualPath)

Return the name of an existing application.

Parameters:

virtualPath - the virtual path of an existing application. Please note that virtual path is the unique identifier of an application.

Returns:

name the name of an existing application.

getApplicationPublication

public java.lang.String getApplicationPublication(java.lang.String vp)
                                           throws ResException

Return the publication associated with an application.

Parameters:

vp - the virtual path of the application.

Returns:

the publication of an application.

Throws:

ResException

getApplicationPublishedTime

public java.sql.Timestamp getApplicationPublishedTime(java.lang.String virtualPath)

Return the time an application was published.

Parameters:

virtualPath - the virtual path of an existing application Please note that the virtual path is the unique identifier of an application.

Returns:

the time (Timestamp) of when the application was published.

getApplicationRepositoryDirectory

public java.lang.String getApplicationRepositoryDirectory(java.lang.String vp)

Return the repository directory of an application.

Parameters:

vp - the virtual path of the application.

Returns:

the repository directory of an application.

getApplicationUsers

public java.util.Enumeration getApplicationUsers(java.lang.String virtualPath)

Return an enumeration of the users associated with an application.

Parameters:

virtualPath - the virtual path of the application.

Returns:

an enumeration of the users associated with an application.

getDBConnections

public int getDBConnections(java.lang.String virtualPath)

Return the number of database connections for an existing application.

Parameters:

virtualPath - the virtual path of an existing application. Please note that the virtual path is the unique identifier of an application.

Returns:

the number of database connections, which is greater than or equal to zero.

getDBConnectionSharing

public boolean getDBConnectionSharing(java.lang.String virtualPath)

Return the database connection sharing setting for an application.

Parameters:

virtualPath - the virtual path of an existing application. Please note that the virtual path is the unique identifier of an application.

Returns:

the database connection sharing setting for an application. true if connection sharing is allowed; false otherwise.

getDBUser

public java.lang.String getDBUser(java.lang.String virtualPath)

Return the database username for an existing application.

Parameters:

virtualPath - the virtual path of an existing application. Please note that the virtual path is the unique identifier of an application.

Returns:

the database username for an existing application. NULL if application does not exist.

getDSN

public java.lang.String getDSN(java.lang.String vp)

Return the DSN of an application.

Parameters:

vp - the virtual path of the application.

Returns:

the DSN of an application.

getFullName

public java.lang.String getFullName(java.lang.String userName)
                             throws ResException

Return the fullname information of an existing Mobile Server user.

Parameters:

userName - the username of an existing Mobile Server user.

Returns:

fullname the fullname information for this user.

Throws:

ResException

getGroupAccess

public boolean getGroupAccess(java.lang.String virtualPath,
                     java.lang.String groupName)

Return application access for the user group.

Parameters:

virtualPath - the virtual path for an existing Mobile Server application.

groupName - the name of the User group.

Returns:

true if the group has access for this application; false otherwise.

getGroupRoleAccess

public boolean getGroupRoleAccess(java.lang.String virtualPath,
                         java.lang.String groupName,
                         java.lang.String role)

Return the group access with certain role for an application.

Parameters:

virtualPath - the virtual path for an existing Mobile Server application.

groupName - the name of the group.

role - a role that is associated with this application.

Returns:

true if the group has access to this application with the specified role; false, otherwise.

getGroupUserAccess

public boolean getGroupUserAccess(java.lang.String virtualPath,
                         java.lang.String groupName,
                         java.lang.String userName)

This will check if an user belongs to a group and if that group has access to an application.

Parameters:

virtualPath - the virtual path of an existing application.

groupName - the name of an existing group that has access to this application

userName - the name of an existing user

Returns:

true if the user belongs to the group AND the group has access to the application; false otherwise

See Also:

(String, String, String, boolean)

getPrivilege

public java.lang.String getPrivilege(java.lang.String userName)

Return the privilege of an existing Mobile Server user.

Parameters:

userName - the username of an existing Mobile Server user.

Returns:

privilege the privilege for this user.

See Also:

(String, String)

getPublication

public java.lang.String getPublication(java.lang.String virtualPath)

Return the name of the Consolidator publication associated with an application.

Parameters:

virtualPath - the virtual path of an existing application.

Returns:

the Consolidator Publication name for this applicaton. It can be null, if either the application or Publication does not exists.

getPublicationItemName

public java.lang.String getPublicationItemName(java.lang.String snapshot,
                                      java.lang.String appVP)

This is a link between MobileResourceManager API and Consolidator API. This will return the Consolidator publication item name. With which the user will be able to do advanced tuning using Consolidator API.

Parameters:

snapshot - the name of an existing snapshot.

appVP - the virtual path of the application that this Publication Item belongs to.

Returns:

the Consolidator Publication item name for this snapshot. It can be null, if either the snapshot or platform does not exists.

getSnapshotTemplate

public java.lang.String getSnapshotTemplate(java.lang.String snapshot,
                                   java.lang.String appVP)

Return the snapshot template string.

Parameters:

snapshot - the name of the snapshot.

Returns:

the template for the snapshot; NULL if failed.

getTemplateVariable

public java.lang.String getTemplateVariable(java.lang.String virtualPath,
                                   java.lang.String userName,
                                   java.lang.String varName)

Return the value of an application snapshot template variable for one user. When an application has more than one snapshot template variable, it is more efficient to use getTemplateVariables ().

Parameters:

virtualPath - the virtual path of an application.

userName - the username of the user.

varName - the name of the variable.

Returns:

the value of the template variable for this user in a String. NULL if it does not exist.

See Also:

getTemplateVariables(String, String)

getTemplateVariables

public java.util.Hashtable getTemplateVariables(java.lang.String virtualPath,
                                       java.lang.String userName)

Return the values of all the application snapshots template variables for one user. Please note that the user need to have access to the application.

Parameters:

virtualPath - the virtual path of the application.

userName - the username of the user.

Returns:

a hashtable of all the snapshots variables for an existing application, that this user has been assigned value. It could be NULL if the user has no access to the application or the application does not use any snapshot template variables.

getUserAccess

public boolean getUserAccess(java.lang.String virtualPath,
                    java.lang.String userName)

Return application access for the user at the user level. Even if a user does not have access to the application at the user level, the user might still be able to access an application through the group that the user belongs to. Use hasAccess () to determine if a user have access to an application, regardless of whether the user has access through the user or group level.

Parameters:

virtualPath - the virtual path for an existing Mobile Server application.

userName - the username of the user.

Returns:

true if the user has access for this application at the user level; false, otherwise.

getUserGroupList

public java.util.Vector getUserGroupList(java.lang.String userName)
                                  throws ResException

Return a vector of id of the groups that an user has access.

Parameters:

userName - the username of the user.

Returns:

a vector of id of the groups that the user has access.

Throws:

ResException

getUserGroupNameList

public java.util.Vector getUserGroupNameList(java.lang.String userName)
                                      throws ResException

Return a vector of groups names that a user has access to.

Parameters:

userName - the username of the user.

Returns:

a vector of group names that the user has access to.

Throws:

ResException

getUserPublications

public java.util.Vector getUserPublications(java.lang.String userName,
                                   java.lang.String platform)
                                     throws java.lang.Exception

Return a vector of publications associated with a user.

Parameters:

userName - the name of the user.

platform - the platform associated.

Returns:

a vector of publications associated with a user.

Throws:

java.lang.Exception

getUserRoleAccess

public boolean getUserRoleAccess(java.lang.String virtualPath,
                        java.lang.String userName,
                        java.lang.String role)

Return the user access for an application with certain role.

Parameters:

virtualPath - the virtual path for an existing Mobile Server application.

userName - the username of the user.

role - a role that is associated with this application.

Returns:

the user access for an application with the specified role.

hasAccess

public boolean hasAccess(java.lang.String virtualPath,
                java.lang.String userName)

Return application access for the user at the user level. as well as group level.

Parameters:

virtualPath - virtual for an existing Mobile Server application.

userName - the name of the user.

Returns:

true if the user has access to the application; false, otherwise.

isAPI

public void isAPI(boolean flag)

Mobile Server can have a dependency on servlet.jar. When writing a Mobile Server program and if that needs to be changed, you can call this method.

Parameters:

flag - true to set up the dependency; false to break it

isServerSuspended

public boolean isServerSuspended()

* Return the status of Mobile Server - suspended (single user) or * running in regular mode. * @return True if Suspended, false otherwise * @deprecated

listApplications

public java.util.Vector listApplications(java.lang.String appnamePattern)

List all the Mobile Server applications that match the namePattern. Please note that this search is case-insensitive.

Parameters:

appnamePattern - the pattern that matches the application name.

Returns:

A vector of applications' virtual path (String) whose name matches the application name pattern

listApplicationsByVP

public java.util.Vector listApplicationsByVP(java.lang.String vpPattern)

List applications whose virtual path matches the supplied virtual path pattern. Please note that this search is case-sensitive

Parameters:

vpPattern - the virtual path pattern (SQL). NULL will match for all.

Returns:

a vector of applications' virtual paths that match the virtual path pattern.

listGroupRoles

public java.util.Vector listGroupRoles(java.lang.String virtualPath,
                              java.lang.String groupName)

List the roles a group has for an application. Please note that if a group has access to an application, he/she will ahve the default role.

Parameters:

virtualPath - the name of an existing application.

groupName - the name of an existing group.

Returns:

a vector of roles that the user have on an application

listGroups

public java.util.Vector listGroups(java.lang.String namePattern)

List groups whose name matches the pattern.

Parameters:

namePattern - name search pattern (SQL). NULL will search for all.

Returns:

a vector of groups (String) that matche the name pattern.

listRoles

public java.util.Vector listRoles(java.lang.String virtualPath)

List the roles that are associated with an existing application.

Parameters:

virtualPath - the virtual path of an existing application. Please note that the virtual path is the unique identifier of an application.

Returns:

a vector of Roles that this application is assocated with.

listSnapshots

public java.util.Vector listSnapshots(java.lang.String virtualPath)

List the snapshots associated with an existing application.

Parameters:

virtualPath - the virtual path of an existing application. Please note that the virtual path is the unique identifier of an application.

Returns:

a vector of snapshot names (String) that are associated with an existing application

listTemplateVariables

public java.util.Vector listTemplateVariables(java.lang.String virtualPath)
                                       throws ResException

Lists the name of the all the snapshot template variables for an application on one platform.

Parameters:

virtualPath - the virtual path of an existing application.

Returns:

a vector of the name of all the template variables of a snapshot. Please note the name does not include a leading ":".

Throws:

ResException

listUserApplicationNames

public java.util.Vector listUserApplicationNames(java.lang.String userName)

List all the applicatons that the user have access to.

Parameters:

userName - the userName.

Returns:

a vector of application name. Please note that it is not application virtual path.

listUserApplications

public java.util.Vector listUserApplications(java.lang.String userName)

List all the applicatons that the user have access to.

Parameters:

userName - the userName.

Returns:

a vector of application virtual path.

listUserRoles

public java.util.Vector listUserRoles(java.lang.String virtualPath,
                             java.lang.String userName)

List the roles a user has for an applicaiton. Please note that if an user has access to an application, he/she will have the default role.

Parameters:

virtualPath - the name of an existing application.

userName - the name of an existing user.

Returns:

a vector of roles that the user have on the application.

listUsers

public java.util.Vector listUsers(java.lang.String namePattern)

Find users whose username matches the name pattern.

Parameters:

namePattern - the name search pattern (SQL). NULL will search for all.

Returns:

a vector of user names (String) that matches the given name search pattern. If there is no matching, the vector will have 0 element.

listUsersInGroup

public java.util.Vector listUsersInGroup(java.lang.String groupName)

Return all the users in a user group.

Parameters:

groupName - name of an existing user group.

Returns:

a vector of user names (String) that are in a user group

mobileDisableUser

public void mobileDisableUser(java.lang.String userName)
                       throws ResException

Remove the entry for this user from Mobile Server.

Parameters:

userName - the username of the username

Throws:

ResException

mobileEnableUser

public boolean mobileEnableUser(java.lang.String userName,
                       java.lang.String privilege)
                         throws ResException

Mobile Enable an IAS user residing in OID.

Parameters:

userName - name of the IAS user. Please note that it should not be the name of an existing user or group.

privilege - the Mobile Server user privilege. The value can be one of the following: "O" for publishing an application, "U" for connecting to Mobile Server "A" for administrating Mobile Server. NULL stands for none privilege.

Returns:

true after entery for this user is created in Mobile Server. false if a user or a group of that name already exists in Mobile Server.

Throws:

ResException

publishApplication

public void publishApplication(java.io.File jarFile,
                      java.lang.String username,
                      java.lang.String password,
                      java.lang.String url,
                      boolean isPublicApplication,
                      boolean overwrite)
                        throws ResException

Publish an application jar file.

Parameters:

jarFile - the Mobile Server application jar file created by Mobile Server Packaging Wizard.

username - the Mobile Server user that have the publishing priviliege.

password - the Mobile Server user's password.

url - the url for the application's directory on the Mobile Server.

isPublicApplication - is this application accessible to all user.

overwrite - if set to true, an existing definition for this application is overwritten on the server.

Throws:

ResException - when failed to publish the application.

removeUserFromGroup

public void removeUserFromGroup(java.lang.String groupName,
                       java.lang.String userName)

Removed a user from the given user group. Please note that both the group and the users are assumed to be existing. Otherwise, no action will be taken.

Parameters:

groupName - the name of the user group.

userName - the username of the user.

removeUsersFromGroup

public void removeUsersFromGroup(java.lang.String groupName,
                        java.util.Vector users)

Remove users from the given user group. Please note that both the group and the users are assumed to be existing.

Parameters:

groupName - the name of the user group. This method does nothing if the groupName does not exist.

users - a vector of users names (String) that will be removed.

resumeServer

public void resumeServer()

* Resume Mobile Server and put it in back in Multi user mode. * @deprecated

rollbackTransaction

public void rollbackTransaction()

Rollback the admin tasks in the current active session.

setApplicationClasspath

public void setApplicationClasspath(java.lang.String vp,
                           java.lang.String cp)

Set the classpath of an application.

Parameters:

vp - the virtual path of the application.

cp - the classpath of the application.

setApplicationDefaultPage

public void setApplicationDefaultPage(java.lang.String vp,
                             java.lang.String defaultPage)

Set the default page of an application.

Parameters:

vp - the virtual path of the application.

defaultPage - the name of the default page.

setApplicationDescription

public void setApplicationDescription(java.lang.String virtualPath,
                             java.lang.String description)

Set the description for an existing application.

Parameters:

virtualPath - the virtual path of an existing application. Please note that virtual path is the unique identifier of an application.

description - the new description for an existing application.

setApplicationIcon

public void setApplicationIcon(java.lang.String vp,
                      java.lang.String icon)

Set the icon of an application.

Parameters:

vp - the virtual path of the application.

icon - the icon of an applicaiton.

setApplicationName

public void setApplicationName(java.lang.String virtualPath,
                      java.lang.String appname)

Rename an existing application.

Parameters:

virtualPath - the virtual path of an existing application. Please note that virtual path is the unique identifier of an application.

appname - the new name for this application.

setApplicationPublication

public void setApplicationPublication(java.lang.String vp,
                             java.lang.String pubName)
                               throws ResException

Associate the Consolidator publication of an application.

Parameters:

vp - the virtual path of the application.

pubName - the Consolidator publication of an application.

Throws:

ResException

setApplicationPublishedTime

public void setApplicationPublishedTime(java.lang.String virtualPath)
                                 throws ResException

Set application publish time with the current time.

Parameters:

virtualPath - the virtual path of an existing application. Please note that the virtual path is the unique identifier of an application.

Throws:

ResException

setDBConnections

public void setDBConnections(java.lang.String virtualPath,
                    int connections)

Set the number of database connections for an existing application.

Parameters:

virtualPath - the virtual path of an existing application. Please note that virtual path is the unique identifier of an application.

connections - the number of database connection for an existing application. This can not be negative.

setDBConnectionSharing

public void setDBConnectionSharing(java.lang.String virtualPath,
                          boolean sharing)

Enable/disable the database connection sharing for an existing application.

Parameters:

virtualPath - the virtual path of an existing application. Please note that the virtual path is the unique identifier of an application.

sharing - true if allow database connection sharing; false other wise.

setDBUser

public void setDBUser(java.lang.String virtualPath,
             java.lang.String dbUser,
             java.lang.String dbPwd)

Set the Database User property of an existing application.

Parameters:

virtualPath - the virtual path of an existing application. Please note that the virtual path is the unique identifier of an application.

dbUser - the database user name for the application.

dbPwd - the database user password (in clear text).

setFullName

public void setFullName(java.lang.String userName,
               java.lang.String fullname)
                 throws ResException

Set the full name information for an existing Mobile Server user.

Parameters:

userName - an existing Mobile Server user. No action will be taken if the user already exists.

fullname - the full name information for this Mobile Server user.

Throws:

ResException

setGroupAccess

public void setGroupAccess(java.lang.String virtualPath,
                  java.lang.String groupName,
                  boolean access)

Set application access for a group. Please note that once the group loses access to the application, the group will also lose all the template variable values for the snapshots in the application.

Parameters:

virtualPath - the application virtual path.

groupName - the name of the User Group.

access - true to grant and false to revoke the access.

setGroupRoleAccess

public void setGroupRoleAccess(java.lang.String virtualPath,
                      java.lang.String groupName,
                      java.lang.String role,
                      boolean access)

Set Group access with a role. Please note: 1) once the group lose access to the application, all the users in the group will also lose all the template variable values for the snapshots in the application. 2) it is recommend to use the same method that takes a vector of roles as parameter to reduce the overhead. pre-condition: group have access to the application. Grant or revoke application role for the group. The "Default Role" is always granted to the group.

Parameters:

virtualPath - the application virtual path.

groupName - a group that has access to the application.

role - the application role.

access - TRUE to grant access; FALSE to revoke access for the name role.

setGroupRoleAccess

public void setGroupRoleAccess(java.lang.String virtualPath,
                      java.lang.String groupName,
                      java.util.Vector roles,
                      boolean access)

Grant or revoke application role for the group. The "Default Role" is always granted to the group. pre-condition: the group has access to the application.

Parameters:

virtualPath - the application virtual path.

groupName - a group that has access to the application.

roles - a vector of existing application roles (strings).

access - TRUE to grant access and FALSE to revoke access for the name role.

setGroupUserAccess

public void setGroupUserAccess(java.lang.String virtualPath,
                      java.lang.String groupName,
                      java.lang.String userName,
                      boolean access)

This method assigns finer grain user access to the application in a group level. A user will have access to an application if ONE of the following two holds true: 1) the user have access to the application. 2) the user belongs to a usergroup that has access to the application. However the administrator can fine tune the group by granting/revoking access of individual users in the group for a particular application.

Therefore, in order to revoke a user from accessing an application, BOTH of the following need to be true: 1) the user do not have access to the application. 2) none of the groups that the user belongs to has access to the application OR for all the groups that the user belongs to that has access to the application, the user is revoked access to the application in those groups.

Parameters:

virtualPath - the application virtual path.

groupName - the group that has access to the application.

userName - the username of the user.

access - TRUE to grant access and FALSE to revoke access for the name role.

See Also:

setUserAccess(String, String, boolean), setGroupAccess(String, String, boolean)

setPassword

public boolean setPassword(java.lang.String userName,
                  java.lang.String newpwd)
                    throws ResException

Set password for an existing Mobile Server user.

Parameters:

userName - the username of an existing Mobile Server user. No action will will taken if the user does not exist.

newpwd - this Mobile Server user's new password in clear text.

Returns:

true if new password is set successfully. false if new password is not valid according to specification

Throws:

ResException

setPrivilege

public void setPrivilege(java.lang.String userName,
                java.lang.String privilege)

Set the privilege for an existing Mobile Server user.

Parameters:

userName - the username of an existing Mobile Server user. No action will be taken if the user does not exist.

privilege - the Mobile Server user privilege. The value can be one of the following: "O" for publishing an application, "U" for connecting to Mobile Server "A" for administrating Mobile Server. NULL stands for none privilege.

setTemplateVariable

public void setTemplateVariable(java.lang.String virtualPath,
                       java.lang.String userName,
                       java.lang.String name,
                       java.lang.String value)

Set a snapshot template variable value for a particular user.

Parameters:

virtualPath - the virtual path of an application.

userName - the username of an existing Mobile Server user.

name - the name of the template variable.

value - the value of the template variable.

setTemplateVariables

public void setTemplateVariables(java.lang.String virtualPath,
                        java.lang.String userName,
                        java.util.Hashtable nameValuePairs)

Set snapshot template variables for a particular user.

Parameters:

virtualPath - the virtual path of an application.

userName - the username of an existing Mobile Server user.

nameValuePairs - a hashtable containing the name/value pairs that cover all the template variable of the snapshot. Please note that it does not include the leading ":". Also, the name is case-insensitive.

setUserAccess

public void setUserAccess(java.lang.String virtualPath,
                 java.lang.String userName,
                 boolean access)
                   throws ResException

Sets application access for the user. Please note that once the user loses access to the application, the user will also lose all the template variable values for the snapshots in the application.

Parameters:

virtualPath - the application virtual path.

userName - the username of the user.

access - true grant and false to revoke the access.

Throws:

ResException

setUserCompleteRefresh

public void setUserCompleteRefresh(java.lang.String userName,
                          java.lang.String platform)
                            throws ResException

Set complete refresh on the given platform next time the user do a sync.

Parameters:

userName - the username of an existing user.

platform - a valid platform String.

Throws:

ResException

See Also:

setUserCompleteRefresh(String, int)

setUserRoleAccess

public void setUserRoleAccess(java.lang.String virtualPath,
                     java.lang.String userName,
                     java.lang.String role,
                     boolean access)
                       throws ResException

Grant or revoke application role for the user. The "Default Role" is always granted to the user. NOTE: it is recommend to use the same method that takes a vector of roles as parameter to reduce the overhead. pre-condition: user have access to the application.

Parameters:

virtualPath - the application virtual path.

userName - a user that has access to the application.

role - the application role.

access - true to grant access; false to revoke access for the name role.

Throws:

ResException

setUserRoleAccess

public void setUserRoleAccess(java.lang.String virtualPath,
                     java.lang.String userName,
                     java.util.Vector roles,
                     boolean access)

Grant or revoke application role for the user. The "Default Role" is always granted to the user if the user have access to the application. pre-condition: user have access to the application

Parameters:

virtualPath - application virtual path

userName - a user that has access to the application.

roles - all the roles for this application for this user.

access - true to grant access; false to revoke access for the name role.

setUsersAccess

public void setUsersAccess(java.lang.String virtualPath,
                  java.lang.String[] userName)

Set access of an application for an array of users.

Parameters:

virtualPath - the virtual path of the application.

userName - an array of usernames.

suspendServer

public void suspendServer(oracle.lite.web.WTGUser user)

* Suspend Mobile Server and put it in Single user mode.

Parameters:

user - userName * @deprecated

validateExternalUser

public int validateExternalUser(java.lang.String user,
                       java.lang.String displayName)

validateUser

public int validateUser(java.lang.String user,
               java.lang.String pwd,
               java.lang.String displayName)