UM Manager Java API
6.16.1
|
Public Member Functions | |
UMMAPI (String filename) throws Exception | |
UMMAPI (Properties props) throws Exception | |
void | close () throws SQLException |
boolean | login (String userName, String password) throws Exception |
boolean | logOff () |
boolean | setAdmin (int userType) |
void | setExceptionListener (ExceptionListener listener) |
boolean | deleteApplication (int applicationId) throws Exception |
boolean | deleteApplication (NameValue applicationNV) throws Exception |
boolean | deleteTemplate (int templateId) throws Exception |
boolean | deleteTemplate (NameValue templateNV) throws Exception |
boolean | deleteUser (int userId) throws Exception |
boolean | deleteUser (NameValue userNV) throws Exception |
User | getUser (int userId) throws Exception |
User | getUser (NameValue userNV) throws Exception |
boolean | setUserPassword (int userID, String password) throws Exception |
boolean | setUserPassword (NameValue nv, String password) throws Exception |
NameValue | saveUser (String name, User user) throws Exception |
boolean | saveUser (NameValue userNV, User user) throws Exception |
boolean | setTemplates (String name, ArrayList< NameValue > templates) throws Exception |
boolean | setTemplates (int applicationID, ArrayList< NameValue > templates) throws Exception |
boolean | setTemplates (int applicationID, ArrayList< NameValue > templates, int type) throws Exception |
boolean | setTemplates (NameValue application, ArrayList< NameValue > templates) throws Exception |
boolean | setTemplates (NameValue application, ArrayList< NameValue > templates, int type) throws Exception |
NameValue | saveTemplate (String name, String xml) throws Exception |
boolean | saveTemplate (NameValue templateNV, String xml) throws Exception |
NameValue | saveApplication (String name, String xml) throws Exception |
boolean | saveApplication (NameValue applicationNV, String xml) throws Exception |
boolean | saveApplication (NameValue applicationNV, String xml, int type) throws Exception |
ArrayList< NameValue > | getTemplateNames () throws Exception |
ArrayList< NameValue > | getApplicationNames () throws Exception |
ArrayList< NameValue > | getApplicationNames (int type) throws Exception |
ArrayList< NameValue > | getUserApplicationNames (int userId) throws Exception |
ArrayList< NameValue > | getUserApplicationNames (NameValue userNV) throws Exception |
boolean | setApplications (int userId, ArrayList< NameValue > applicationList) throws Exception |
boolean | setApplications (NameValue userNV, ArrayList< NameValue > applicationList) throws Exception |
ArrayList< NameValue > | getUserNames () throws Exception |
String | getConfig (String applicationName) throws Exception |
String | getConfig (String applicationName, int type) throws Exception |
String | getConfig (NameValue applicationNV, int type) throws Exception |
String | getApplication (String name, int type) throws Exception |
String | getApplication (int applicationId) throws Exception |
String | getApplication (NameValue applicationNV) throws Exception |
String | getTemplate (int templateId) throws Exception |
String | getTemplate (NameValue templateNV) throws Exception |
ArrayList | getAuditLog (long begin, long end) throws Exception |
User | getUser () |
String | getError () |
void umm.api.UMMAPI.close | ( | ) | throws SQLException |
close the UMM system.
SQLException |
boolean umm.api.UMMAPI.deleteApplication | ( | int | applicationId | ) | throws Exception |
Delete an Application.
applicationId | The ID of the Application. |
Exception |
boolean umm.api.UMMAPI.deleteApplication | ( | NameValue | applicationNV | ) | throws Exception |
Delete an Application.
applicationNV | The NameValue that contains the id of the Application. |
Exception |
boolean umm.api.UMMAPI.deleteTemplate | ( | int | templateId | ) | throws Exception |
Delete a Template.
templateId | The id of an existing Template. |
Exception |
boolean umm.api.UMMAPI.deleteTemplate | ( | NameValue | templateNV | ) | throws Exception |
Delete a Template.
templateNV | The NameValue object that contains the id of an existing Template. |
Exception |
boolean umm.api.UMMAPI.deleteUser | ( | int | userId | ) | throws Exception |
Delete an existing User.
userId |
Exception |
boolean umm.api.UMMAPI.deleteUser | ( | NameValue | userNV | ) | throws Exception |
Delete an existing User.
Exception |
References umm.api.UMMAPI.getUserNames().
String umm.api.UMMAPI.getApplication | ( | String | name, |
int | type | ||
) | throws Exception |
Get the XML for an Application.
name | Name. |
type | The application type. |
Exception |
Referenced by umm.api.UMMAPI.getApplication().
String umm.api.UMMAPI.getApplication | ( | int | applicationId | ) | throws Exception |
Get the XML for an Application.
applicationId | The ID for an application. |
Exception |
References umm.api.UMMAPI.getApplication().
String umm.api.UMMAPI.getApplication | ( | NameValue | applicationNV | ) | throws Exception |
Get the XML for an Application.
applicationNV | This must contain the id of the application. |
Exception |
ArrayList<NameValue> umm.api.UMMAPI.getApplicationNames | ( | ) | throws Exception |
Returns a list of application NameValue objects that contains the name and id of each application. Returns null on failure. The method "getError" will return the reason for the failure.
Exception |
Referenced by umm.api.UMMAPI.saveApplication(), umm.api.UMMAPI.setApplications(), and umm.api.UMMAPI.setTemplates().
ArrayList<NameValue> umm.api.UMMAPI.getApplicationNames | ( | int | type | ) | throws Exception |
Returns a list of application NameValue objects that contains the name and id of each application. Returns null on failure. The method "getError" will return the reason for the failure.
type | The application type that is associated with the application. |
Exception |
ArrayList umm.api.UMMAPI.getAuditLog | ( | long | begin, |
long | end | ||
) | throws Exception |
Get the Audit Log. Times are in milliseconds.
begin | The start time in milliseconds since 1970. |
end | The end time in milliseconds since 1970. |
Exception |
References umm.api.UMMAPI.getUser().
String umm.api.UMMAPI.getConfig | ( | String | applicationName | ) | throws Exception |
Get the XML for an Application.
applicationName | This is the name of the application. |
Exception |
Referenced by umm.api.UMMAPI.getConfig().
String umm.api.UMMAPI.getConfig | ( | String | applicationName, |
int | type | ||
) | throws Exception |
Get the XML for an Application.
applicationName | This is the name of the application. |
type | The application type. |
Exception |
References umm.api.UMMAPI.getConfig().
String umm.api.UMMAPI.getConfig | ( | NameValue | applicationNV, |
int | type | ||
) | throws Exception |
Get the XML for an Application.
applicationNV | This must contain the the name of the application. |
type | The application type. |
Exception |
References umm.api.User.getUserType().
String umm.api.UMMAPI.getError | ( | ) |
Return the last error.
References umm.api.NameValue.getName().
String umm.api.UMMAPI.getTemplate | ( | int | templateId | ) | throws Exception |
Get the XML for a Template.
templateId | The ID for a template. |
Exception |
String umm.api.UMMAPI.getTemplate | ( | NameValue | templateNV | ) | throws Exception |
Get the XML for a Template.
templateNV | This must contain the id of the template. |
Exception |
ArrayList<NameValue> umm.api.UMMAPI.getTemplateNames | ( | ) | throws Exception |
Get all Template names.
Exception |
Referenced by umm.api.UMMAPI.saveTemplate(), and umm.api.UMMAPI.setTemplates().
User umm.api.UMMAPI.getUser | ( | int | userId | ) | throws Exception |
Get User information for an existing User.
userId | The id of an existing User. |
Exception |
References umm.api.UMMAPI.getUser().
Referenced by umm.api.UMMAPI.getAuditLog(), and umm.api.UMMAPI.getUser().
Returns the Applications that are assigned to a user.
userNV | - This must contain the user ID for an existing user. |
Exception |
ArrayList<NameValue> umm.api.UMMAPI.getUserNames | ( | ) | throws Exception |
Get all the User names.
Exception |
Referenced by umm.api.UMMAPI.deleteUser(), and umm.api.UMMAPI.saveUser().
boolean umm.api.UMMAPI.login | ( | String | userName, |
String | password | ||
) | throws Exception |
boolean umm.api.UMMAPI.logOff | ( | ) |
Log off of the UMM system.
NameValue umm.api.UMMAPI.saveApplication | ( | String | name, |
String | xml | ||
) | throws Exception |
Save the XML for a Application.
name | The name of the application. |
xml | The xml that will associated with the application. |
References umm.api.UMMAPI.getApplicationNames(), and umm.api.NameValue.getName().
Referenced by umm.api.UMMAPI.saveApplication().
boolean umm.api.UMMAPI.saveApplication | ( | NameValue | applicationNV, |
String | xml | ||
) | throws Exception |
Save the XML for a Application.
applicationNV | This must contain the application ID for an existing user or -1 for a new application. |
xml | The xml that will associated with the application. |
Exception |
References umm.api.UMMAPI.saveApplication().
boolean umm.api.UMMAPI.saveApplication | ( | NameValue | applicationNV, |
String | xml, | ||
int | type | ||
) | throws Exception |
Save the XML for a Application.
applicationNV | This must contain the application ID for an existing user or -1 for a new application. |
xml | The xml that will associated with the application. |
type | The applicatin type that will associated with the application. |
Exception |
NameValue umm.api.UMMAPI.saveTemplate | ( | String | name, |
String | xml | ||
) | throws Exception |
Save the XML for a Template.
name | The name of the template. |
xml | The xml that will associated with the template. |
References umm.api.NameValue.getName(), and umm.api.UMMAPI.getTemplateNames().
boolean umm.api.UMMAPI.saveTemplate | ( | NameValue | templateNV, |
String | xml | ||
) | throws Exception |
Save the XML for a Template.
templateNV | This must contain the template ID for an existing template or -1 for a new template. |
xml | The xml that will associated with the template. |
Exception |
Save the User. This method is used to save new or existing users.
name | The name of the user. |
user | This User object contains all of the user information. |
References umm.api.UMMAPI.getUserNames().
Save the User. This method is used to save new or existing users.
userNV | This must contain the user ID for an existing user or -1 for a new user. |
user | This User object contains all of the user information. |
Exception |
References umm.api.NameValue.setValue().
boolean umm.api.UMMAPI.setAdmin | ( | int | userType | ) |
Set the admin privilege. The privilege can only go from ADMIN to Normal. The getConfig method returns different results for an "Admin" and "Normal" users.
userType | Set to User.ADMIN or User.NORMAL |
References umm.api.User.getUserType(), and umm.api.User.setUserType().
boolean umm.api.UMMAPI.setApplications | ( | int | userId, |
ArrayList< NameValue > | applicationList | ||
) | throws Exception |
boolean umm.api.UMMAPI.setApplications | ( | NameValue | userNV, |
ArrayList< NameValue > | applicationList | ||
) | throws Exception |
Set the Applications for a User.
userNV | This must contain the user ID for an existing user. |
applicationList | The list of applications that are to be assign to the User. |
Exception |
References umm.api.UMMAPI.getApplicationNames().
void umm.api.UMMAPI.setExceptionListener | ( | ExceptionListener | listener | ) |
Set an Exception Listener. The exceptionThrown method will be called when an exception happens.
listener |
boolean umm.api.UMMAPI.setTemplates | ( | String | name, |
ArrayList< NameValue > | templates | ||
) | throws Exception |
Set the Templates for an Application.
name | The application to assign the templates to. |
templates | A list of templates to assign to the application. |
Exception |
References umm.api.UMMAPI.getApplicationNames(), and umm.api.NameValue.getName().
Referenced by umm.api.UMMAPI.setTemplates().
boolean umm.api.UMMAPI.setTemplates | ( | int | applicationID, |
ArrayList< NameValue > | templates | ||
) | throws Exception |
Set the Templates for an Application.
applicationID | The application to assign the templates to. |
templates | A list of templates to assign to the application. |
Exception |
References umm.api.UMMAPI.setTemplates().
boolean umm.api.UMMAPI.setTemplates | ( | int | applicationID, |
ArrayList< NameValue > | templates, | ||
int | type | ||
) | throws Exception |
Set the Templates for an Application.
applicationID | The application to assign the templates to. |
templates | A list of templates to assign to the application. |
type | The application type. |
Exception |
References umm.api.UMMAPI.setTemplates().
boolean umm.api.UMMAPI.setTemplates | ( | NameValue | application, |
ArrayList< NameValue > | templates | ||
) | throws Exception |
Save the XML for a Template.
application | The name of the template. |
application | The application ID. |
templates | List of templates. |
Exception |
References umm.api.UMMAPI.setTemplates().
boolean umm.api.UMMAPI.setTemplates | ( | NameValue | application, |
ArrayList< NameValue > | templates, | ||
int | type | ||
) | throws Exception |
Save the XML for a Template.
application | The name of the template. |
templates | List of templates. |
type | The Application type. |
Exception |
References umm.api.UMMAPI.getApplicationNames(), and umm.api.UMMAPI.getTemplateNames().
boolean umm.api.UMMAPI.setUserPassword | ( | int | userID, |
String | password | ||
) | throws Exception |
Set the password for a user.
userID | The id of an existing user. |
password | The new password. |
Exception |
Referenced by umm.api.UMMAPI.setUserPassword().
boolean umm.api.UMMAPI.setUserPassword | ( | NameValue | nv, |
String | password | ||
) | throws Exception |
Set the password for a user. The integer value in the NameValue object will used to set the password.
nv | |
password |
Exception |
References umm.api.UMMAPI.setUserPassword().