AdminServiceImpl (P2J - Progress 4GL to Java Conversion and Runtime)

java.lang.Object
- javax.servlet.GenericServlet
- - javax.servlet.http.HttpServlet
  - - com.google.gwt.user.server.rpc.AbstractRemoteServiceServlet
    - - com.google.gwt.user.server.rpc.RemoteServiceServlet
      - com.goldencode.p2j.admin.server.AdminServiceImpl

All Implemented Interfaces:

AdminService, com.google.gwt.user.client.rpc.RemoteService, com.google.gwt.user.server.rpc.SerializationPolicyProvider, java.io.Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig
```
public class AdminServiceImpl
extends com.google.gwt.user.server.rpc.RemoteServiceServlet
implements AdminService
```
Implements the remote server administration interface.

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from interface com.goldencode.p2j.admin.shared.AdminService
  AdminService.App

Field Summary
- Fields inherited from class com.google.gwt.user.server.rpc.AbstractRemoteServiceServlet
  perThreadRequest, perThreadResponse

Constructor Summary

Constructors
Constructor and Description

AdminServiceImpl()

Constructors
Constructor and Description
`AdminServiceImpl()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`addAcl(java.lang.String resourceType, Acl acl, java.util.Map<java.lang.Integer,java.lang.String> subjMap)` Adds new set of ACLs based on the contents of the given ACL definition.
`boolean`	`addAclInstance(java.lang.String instanceName)` Creates an empty container for the specified ACL instance.
`boolean`	`addCert(CertDef cert)` Adds a new certificate according to its definition.
`boolean`	`addDatabase(java.lang.String name, DatabaseDef logging)` Adds the database definition for the given instance name
`java.lang.Boolean`	`addDatabaseToTenant(java.lang.String tenantName, TenantDatabaseDescriptor db)` Function for adding a database instance to a tenant.
`boolean`	`addExports(java.lang.String name, ExportsDef logging)` Adds the export definition for the given name
`boolean`	`addGroup(GroupDef group)` Adds new group account definition.
`boolean`	`addLogging(java.lang.String name, LoggingDef logging)` Adds the logging definition for the given name
`boolean`	`addOsUser(OsUserDef user)` Adds the OS user.
`boolean`	`addPersistence(java.lang.String name, PersistenceDef persistence)` Adds the persistence definition for the given instance name
`boolean`	`addProcess(ProcessDef process, java.io.Serializable ext)` Adds new process account definition.
`boolean`	`addRuntime(java.lang.String serverName, java.lang.String accountName, RuntimeDef runtime)` Adds the runtime definition for the given server and account names.
`boolean`	`addStartup(java.lang.String name, StartupDef logging)` Adds the startup definition for the given instance name
`java.lang.Boolean`	`addTenant(java.lang.String tenantName, java.util.List<TenantDatabaseDescriptor> databases)` Add a tenant to the list.
`boolean`	`addUser(UserDef user, java.io.Serializable ext)` Adds new user account definition.
`boolean`	`backupDirectory(java.lang.String newfile)` Backup the directory into a new file.
`int`	`bulkAuthModeUpdate(int targetAccounts, java.lang.String[] excludedAccounts, int authMode, java.lang.String authPlugin)` Preforms bulk update of authentication settings of the accounts of the specified type.
`void`	`cancelRereadDir()` Cancel (possibly) planned refreshing operation.
`boolean`	`canRefresh()` Check if current user can perform a refresh.
`boolean`	`changeGroupUsers(java.lang.String name, java.lang.String[] additions, java.lang.String[] deletions)` Changes the group by adding and/or removing users.
`boolean`	`changeHolidays(java.util.Date[] additions, java.util.Date[] deletions)` Modifies defined holidays.
`JarOpErrorCode`	`changeJarHookClass(java.lang.String jar, java.lang.String hookClass)` Change the server-wide or global hook class of the specific jar.
`JarOpErrorCode`	`changeJarHooksType(boolean serverWide, boolean move)` Make the current server use server-wide or global hooks, optionally copying or moving hooks from one scope to another.
`boolean`	`changeResourceNames(java.lang.String[] additions, java.lang.String[] deletions)` Modifies resource name definitions.
`java.lang.Boolean`	`changeTenantStatus(java.lang.String tenantName, boolean enable)` Enable/Disable a specific tenant.
`TaggedName`	`checkGroup(java.lang.String name)` Check the group account existence.
`TaggedName`	`checkOsUser(java.lang.String name)` Check the user account existence.
`TaggedName`	`checkProcess(java.lang.String name)` Check the process account existence.
`TaggedName`	`checkUser(java.lang.String name)` Check the user account existence.
`void`	`clearMessages()` Clears the old messages saved on the server, if any.
`boolean`	`cloneAcl(java.lang.String resourceType, java.lang.String instanceName, int oid, int cloneOid)` Clones the specified ACL to another position within the same ACL instance.
`boolean`	`cloneAclInstance(java.lang.String instanceFrom, java.lang.String instanceTo)` Clones entire ACL instance.
`boolean`	`cloneAclInstance(java.lang.String resourceType, java.lang.String instanceFrom, java.lang.String instanceTo)` Clones the resource specific part of an ACL instance.
`boolean`	`cloneDatabase(java.lang.String nameFrom, java.lang.String nameTo)` Clones the database definition from the source to the target.
`boolean`	`cloneExports(java.lang.String nameFrom, java.lang.String nameTo)` Clones the export definition from the source to the target.
`boolean`	`cloneGroup(java.lang.String nameFrom, java.lang.String nameTo, boolean acls)` Clones an existing group account into a new one.
`boolean`	`cloneLogging(java.lang.String nameFrom, java.lang.String nameTo)` Clones the logging definition from the source to the target.
`boolean`	`clonePersistence(java.lang.String nameFrom, java.lang.String nameTo)` Clones the persistence definition from the source to the target.
`boolean`	`cloneProcess(java.lang.String nameFrom, java.lang.String nameTo, boolean acls)` Clones an existing process account into a new one.
`boolean`	`cloneRuntime(java.lang.String serverNameFrom, java.lang.String accountNameFrom, java.lang.String serverNameTo, java.lang.String accountNameTo)` Clones the runtime definition from the source to the target.
`boolean`	`cloneStartup(java.lang.String nameFrom, java.lang.String nameTo)` Clones the startup definition from the source to the target.
`boolean`	`cloneUser(java.lang.String nameFrom, java.lang.String nameTo, boolean acls)` Clones an existing user account into a new one, password included.
`boolean`	`cloneUser(java.lang.String nameFrom, java.lang.String nameTo, boolean acls, java.lang.String newPassword)` Clones an existing user account into a new one and assigns the provided password to the clone.
`boolean`	`deleteAcl(java.lang.String resourceType, java.lang.String instanceName, int oid)` Deletes the specified ACL from the specified ACL instance.
`boolean`	`deleteAclInstance(java.lang.String instanceName)` Deletes entire ACL instance from the directory.
`boolean`	`deleteAclInstance(java.lang.String resourceType, java.lang.String instanceName)` Deletes the resource specific part of an ACL instance from the directory.
`boolean`	`deleteCert(java.lang.String alias, boolean force)` Deletes an existing certificate conditionally or unconditionally.
`boolean`	`deleteDatabase(java.lang.String name)` Deletes the database definition of the given database name.
`java.lang.Boolean`	`deleteDatabaseFromTenant(java.lang.String tenantName, java.lang.String pdbName)` Delete a database instance that is assigned to a tenant.
`boolean`	`deleteExports(java.lang.String name)` Deletes the export definition of the given name.
`boolean`	`deleteGroup(java.lang.String name)` Deletes a group account definition.
`boolean`	`deleteLogging(java.lang.String name)` Deletes the logging definition of the given name.
`boolean`	`deleteOsUser(java.lang.String name)` Deletes an OS user account definition.
`boolean`	`deletePersistence(java.lang.String name)` Deletes the persistence definition of the given name.
`boolean`	`deleteProcess(java.lang.String name)` Deletes a process account definition.
`boolean`	`deleteRuntime(java.lang.String serverName, java.lang.String accountName)` Deletes the runtime definition for the given server and account names.
`boolean`	`deleteStartup(java.lang.String name)` Deletes the startup definition of the given name.
`java.lang.Boolean`	`deleteTenant(java.lang.String tenantName)` Function for deleting a tenant from the master table.
`boolean`	`deleteUser(java.lang.String name)` Deletes a user account definition.
`JarOpErrorCode`	`deregisterJar(java.lang.String jar, boolean force, boolean removeFromDirectory)` Remove registration for the specified jar.
`JarOpErrorCode`	`deregisterJarAPI(java.lang.String jar, java.lang.String interfaceClass, boolean force)` Remove registration of the specified API in the specified jar.
`JarOpErrorCode`	`deregisterJarFromDirectory(java.lang.String jar, java.lang.String storedHookClass)` Remove jar registration from the directory.
`java.lang.Float`	`forceFloatSerialization()` This method forces GWT to include Float into the list of serializable types.
`private date[]`	`fromDTO(java.util.Date[] dts)` Converts `java.util.Date[]`, the array of data transferable objects, into the array of `com.goldencode.p2j.util.date` objects.
`AclDef`	`getAcl(java.lang.String resourceType, java.lang.String instanceName)` Gets the full ACL definition information from the directory for the specified ACL instance and resource type.
`SessionInfo[]`	`getActiveSessions(java.lang.String jar, java.lang.String apiInterfaceClass)` Get the list of all active sessions which have executed the specified API or API(s) associated to the specified jar.
`AdminDef`	`getAdminDef()` Returns the configuration information about the administration interface itself.
`AclDef[]`	`getAllAcls(java.lang.String instanceName)` Gets the full ACL definition information from the directory for the specified ACL instance or all of them.
`AuditDef`	`getAudit()` Gets the audit.
`AuthConfigDef`	`getAuthConfig()` Gets authentication configuration, which includes authentication mode, password aging and security tracing level.
`java.lang.String[]`	`getAvailableJarAPIImplClasses(java.lang.String jar, java.lang.String interfaceClass)` Get the list of classes which reside in the specified jar and statically implement all methods defined by the specified interface.
`java.lang.String[]`	`getAvailableJarAPIInterfaces(java.lang.String jar, boolean showRegistered)` Get the list of interfaces available in the specified jar file.
`java.lang.String[]`	`getAvailableJarHookClasses(java.lang.String jar)` Get the list of classes which reside into the specified jar file and implement the `InitTermListener` interface.
`CertDef`	`getCert(java.lang.String alias)` Returns a DER-encoded certificate like those found in *.PEM files.
`TaggedName[]`	`getCertAccounts(java.lang.String alias)` Returns an array of all account names with their description for accounts sharing this certificate.
`java.util.Map<java.lang.String,java.lang.String>`	`getCertificateDNProperties(CertDef cd, boolean owner)` Get a map of the owner or issuer Distinctive Name properties.
`java.lang.String`	`getCertificateDNProperty(CertDef cd, java.lang.String prop, boolean owner)` Get the value of the specified property, from the Distinctive Name entry associated with the owner or issuer.
`TaggedName[]`	`getCertificateHierarchy(java.lang.String alias)` Given a certificate alias, it will compute the certificate signing chain.
`java.util.Map<java.lang.String,java.lang.Object>`	`getCertificateProperties(CertDef cd)` Loads the X509 certificate from the specified definition and returns a map with properties for: `CertificateUtils.CERT_OWNER` - this property will keep a Map of Distinctive Name properties for the owner `CertificateUtils.CERT_ISSUER` - this property will keep a Map of Distinctive Name properties for the issuer `CertificateUtils.CERT_VALIDITY_NOT_BEFORE` - the date from which this certificate starts to be valid.
`TaggedName[]`	`getCertProcesses(java.lang.String alias)` Returns an array of process account names with their description for processes sharing this certificate.
`TaggedName[]`	`getCertUsers(java.lang.String alias)` Returns an array of user account names with their description for users sharing this certificate.
`DatabaseDef`	`getDatabase(java.lang.String name)` Returns the database definition by the given database instance name.
`java.lang.String[]`	`getDatabases()` Get the list of databases managed by this P2J server.
`java.lang.String[]`	`getDatabaseTables(java.lang.String database)` Get the list of tables of the given database.
`AclDef`	`getEffectiveAcls(java.lang.String resourceType)` Gets the combined ACL definition information from the directory for the specified resource type.
`ExportsDef`	`getExports(java.lang.String name)` Returns the export definition by the given export instance name.
`GroupDef`	`getGroup(java.lang.String name)` Returns the group definition for the specified group name.
`RecordInfo[]`	`getLockRecords()` Gets the records which have been previously locked in the given context using `lockRecords(com.goldencode.p2j.admin.RecordInfo[])`.
`LoggingDef`	`getLogging(java.lang.String name)` Returns the logging definition by the given name.
`TaggedName`	`getManagedLibsDirInformation()` Get information about managed libraries directory (path to it and information whether it exists).
`java.lang.String[][]`	`getMessages(boolean all)` Returns an array of messages accumulated since the previous call or all messages since the last message cleanup.
`OsUserDef`	`getOsUser(java.lang.String name)` Returns the OS user account definition for the specified account name.
`PersistenceDef`	`getPersistence(java.lang.String name)` Returns the persistence definition by the given persistence instance name.
`ReportPreview`	`getPreviewImages(ReportRequest reportRequest, com.google.gwt.view.client.Range range)` Gets report preview.
`ProcessDef`	`getProcess(java.lang.String name)` Returns the process definition for the specified process name.
`AdminProfile[]`	`getProfile(java.lang.String[] name)` Returns the admin permissions profile for an arbitrary set of resource instance names.
`AdminProfile[]`	`getProfile(java.lang.String name, int[] perm)` Returns the admin permissions profile for an arbitrary set of permissions for a resource instance name.
`RecordLockInfo[]`	`getRecordLockList()` Creates a report of all record locks for the server.
`TaggedName[]`	`getRegisteredJarAPIs(java.lang.String jar)` Get the list of APIs registered for the specified jar.
`TaggedName[]`	`getRegisteredJars()` Get the list of registered jars (which represent customer libs).
`java.util.Map<java.lang.String,java.lang.Object>`	`getReportParametersMap()` Returns the map of report parameters to their values saved in the directory.
`java.lang.String`	`getResourceType(java.lang.String name)` Returns the registered resource type name for the given resource plugin.
`RuntimeDef`	`getRuntime(java.lang.String serverName, java.lang.String accountName)` Returns the runtime definition for the given server and account names.
`java.lang.String`	`getServerName()` Returns the server's name.
`SessionInfo[]`	`getSessionList()` Creates a report of all current user and process sessions.
`StartupDef`	`getStartup(java.lang.String name)` Returns the startup definition by the given startup instance name.
`java.lang.String`	`getStoredJarHookClass(java.lang.String jar)` Get hook class specified in the directory for the target jar.
`java.lang.String[]`	`getUnregisteredJars()` Get the list of jars, which reside in the customer libs directory, but haven't been registered yet and do not present in the server classpath.
`UserDef`	`getUser(java.lang.String name)` Returns the user account definition for the specified account name.
`java.lang.String`	`getVersionInfo()` Returns the current application version.
`boolean`	`isMaster()` Tells whether the server can modify the directory.
`boolean`	`isRefreshPending()` Check if there is pending security cache refresh.
`java.lang.Boolean`	`isSelfSigned(CertDef cert)` Check if the given certificate is self-signed.
`java.lang.Boolean`	`isTenantEnabled(java.lang.String tenantName)` Check if a specific tenant is enabled or not.
`java.lang.Boolean`	`isUsingMultiClassLoader()` Allows to determine whether `MultiClassLoader` is used as the system class loader.
`java.lang.Boolean`	`isUsingServerWideHooks()` Returns information whether server-wide or global hooks are used for the current server.
`java.lang.String[]`	`listAclInstances()` Locates all instances of ACLs in the directory and returns their names.
`java.lang.String[]`	`listAclInstances(java.lang.String resourceType)` Locates all instances of ACLs in the directory and returns their names for those instances which have ACLs defined for the specified resource type.
`TaggedName[]`	`listAssociatedFwdUsers(java.lang.String osUser)` Returns an array of defined FWD user names, associated with the OS user.
`TaggedName[]`	`listAuthCerts(boolean unusedOnly)` Returns an array of defined Certificate Authority certificates with their distinctive names.
`TaggedName[]`	`listAuthPlugins()` Get the list of available auth plugins.
`java.lang.String[]`	`listDatabaseInstances()` Returns the list of database instances.
`java.lang.String[]`	`listExportsInstances()` Returns the list of export instances.
`TaggedName[]`	`listGroups()` Returns an array of defined group names.
`TaggedName[]`	`listGroupUsers(java.lang.String name)` Enumerates the users of a named group.
`java.util.Date[]`	`listHolidays()` Returns an array of defined holidays.
`java.lang.String[]`	`listInstanceAcls(java.lang.String instanceName)` Lists resource names for which the specified ACL instance has ACLs defined.
`java.lang.String[]`	`listLoggingInstances()` Returns the list of logging instances.
`TaggedName[]`	`listOsUsers()` Returns an array of defined OS user names and their hashed passwords.
`TaggedName[]`	`listPeerCerts(boolean unusedOnly)` Returns an array of defined peer (non-CA) certificates with their distinctive names.
`java.lang.String[]`	`listPersistenceInstances()` Returns the list of persistence instances.
`TaggedName[]`	`listProcesses()` Returns an array of defined process names with their descriptions.
`java.lang.String[]`	`listResourceNames()` Returns an array of resource plugin names.
`java.lang.String[]`	`listRuntimeAccounts()` Returns the list of runtime accounts names.
`java.lang.String[]`	`listRuntimeNames()` Returns the list of runtime names.
`java.lang.String[]`	`listRuntimeServers()` Returns the list of runtime servers.
`java.lang.String[]`	`listServers()` Returns the list of all server instances found in the directory under the "/server" node.
`java.lang.String[]`	`listServers(java.lang.String containers)` Returns the list of server instances under the "/server" node, that have the specified container (or nested chain of) as a child.
`java.lang.String[]`	`listStartupInstances()` Returns the list of startup instances.
`java.util.List<TenantManager.Tenant>`	`listTenants()` Get a list with all the tenants.
`TaggedName[]`	`listUserGroups(java.lang.String name)` Enumerates the groups the named user is part of.
`TaggedName[]`	`listUsers()` Returns an array of defined user account names and their owners.
`boolean`	`lockForRereadDir(int seconds)` Lock directory for rereading from the file.
`boolean`	`lockRecords(RecordInfo[] records)` Lock the specified records.
`boolean`	`moveAcl(java.lang.String resourceType, java.lang.String instanceName, int oid, int newOid)` Moves the specified ACL to another position within the same ACL instance.
`boolean`	`moveAcl(java.lang.String resourceType, java.lang.String instanceName, int oid, java.lang.String newInstanceName)` Moves the specified ACL to another ACL instance, private or shared.
`boolean`	`moveAclInstance(java.lang.String instanceFrom, java.lang.String instanceTo)` Moves entire ACL instance.
`boolean`	`moveAclInstance(java.lang.String resourceType, java.lang.String instanceFrom, java.lang.String instanceTo)` Moves the resource specific part of an ACL instance.
`boolean`	`moveCert(java.lang.String aliasFrom, java.lang.String aliasTo)` Changes the certificate's alias.
`boolean`	`moveDatabase(java.lang.String nameFrom, java.lang.String nameTo)` Moves the database definition from the source to the target.
`boolean`	`moveExports(java.lang.String nameFrom, java.lang.String nameTo)` Moves the export definition from the source to the target.
`boolean`	`moveLogging(java.lang.String nameFrom, java.lang.String nameTo)` Moves the logging definition from the source to the target.
`boolean`	`movePersistence(java.lang.String nameFrom, java.lang.String nameTo)` Moves the persistence definition from the source to the target.
`boolean`	`moveRuntime(java.lang.String serverNameFrom, java.lang.String accountNameFrom, java.lang.String serverNameTo, java.lang.String accountNameTo)` Moves the runtime definition from the source to the target.
`boolean`	`moveStartup(java.lang.String nameFrom, java.lang.String nameTo)` Moves the startup definition from the source to the target.
`java.lang.String`	`peekMessage()` Returns the most recent server message without changing its state on the server.
`JarOpErrorCode`	`registerJar(java.lang.String jar, java.lang.String hookClass, boolean storeInDirectory)` Register the specified jar file (which represent a customer lib).
`JarOpErrorCode`	`registerJarAPI(java.lang.String interfaceClass, java.lang.String implementationClass)` Register API specified by the given interface and implementation class.
`int`	`rereadDirectory()` Reread the directory file into the backend's cache after obtaining a refresh lock.
`boolean`	`resequenceAcls(java.lang.String resourceType, java.lang.String instanceName, int start, int step)` Assigns new object IDs sequentially for all ACLs in the given ACL instance and resource type.
`java.lang.String`	`searchCert(java.lang.String dn)` Searches the CA directory for an alias of the certificate by the distinctive name of the subject.
`java.lang.String[]`	`searchRuntimeByAccount(java.lang.String account, java.lang.String itemName)` Returns the list of target runtime names for the given account and the given item name.
`boolean`	`setAcl(java.lang.String resourceType, Acl acl, java.util.Map<java.lang.Integer,java.lang.String> subjMap, boolean setInstance, boolean setInstanceMode, boolean setSubjects, boolean setRights)` Conditionally edits the existing ACL based on the contents of the given ACL and the selected conditions.
`boolean`	`setAudit(AuditDef audit)` Sets the audit.
`boolean`	`setAuthConfig(AuthConfigDef authConfig)` Sets authentication configuration from the specified instance, which includes authentication mode, password aging and security tracing level.
`boolean`	`setCert(CertDef cert)` Replaces an existing certificate with the given one.
`boolean`	`setDatabase(DatabaseDef database)` Sets the database definition.
`boolean`	`setExports(ExportsDef logging)` Sets the export definition.
`boolean`	`setGroup(GroupDef group)` Changes the group definition for the named group.
`boolean`	`setLogging(LoggingDef logging)` Sets the logging definition.
`boolean`	`setOsUser(OsUserDef user)` Sets the OS user.
`boolean`	`setPersistence(PersistenceDef persistence)` Sets the persistence definition.
`boolean`	`setProcess(ProcessDef process)` Changes the process definition for the named process.
`boolean`	`setProcess(ProcessDef process, java.io.Serializable ext)` Changes the process definition for the named process.
`boolean`	`setRuntime(RuntimeDef runtime)` Sets the runtime definition.
`boolean`	`setStartup(StartupDef startup)` Sets the startup definition.
`boolean`	`setTargetFile(java.lang.String name, boolean create)` Sets the specified directory file as the offline target.
`int`	`setTargetLive(boolean stayCurrent)` Sets the live server's directory as the target.
`boolean`	`setUser(UserDef user)` Changes the user account definition for the named account.
`boolean`	`setUser(UserDef user, java.io.Serializable ext)` Changes the user account definition for the named account.
`boolean`	`shutdown()` Shuts the server down.
`int`	`targetRefresh()` Refreshes the current security cache if the target is the live directory and only if there were changes performed since the last call to the targetRefresh().
`void`	`terminateSession(int sid)` Forcibly terminate the specified session.
`private java.util.Date[]`	`toDTO(date[] dts)` Converts `com.goldencode.p2j.util.date[]` to the array of `java.util.Date` data transferable objects.
`boolean`	`unlockRecords()` Unlock the records which has been previously locked in the given context using `lockRecords(com.goldencode.p2j.admin.RecordInfo[])`.
`private static UserDef`	`updateHashedPassword(UserDef userDef)` Update the hashed password if the value of the plain password is given and then the plain password is cleared.
`java.lang.Boolean`	`updateTenant(java.lang.String tenantName, java.lang.String pdbName, java.util.Map<java.lang.String,java.lang.String> values)` Update a tenant from the master table.
`int`	`validateCertificate(CertDef cert)` Validate the given certificate, by its PEM data.

Methods inherited from class com.google.gwt.user.server.rpc.RemoteServiceServlet
checkPermutationStrongName, doGetSerializationPolicy, getCodeServerPolicyUrl, getRequestModuleBasePath, getSerializationPolicy, init, loadPolicyFromCodeServer, onAfterResponseSerialized, onBeforeRequestDeserialized, processCall, processCall, processPost, shouldCompressResponse

Methods inherited from class com.google.gwt.user.server.rpc.AbstractRemoteServiceServlet
doPost, doUnexpectedFailure, getPermutationStrongName, getThreadLocalRequest, getThreadLocalResponse, onAfterRequestDeserialized, readContent

Methods inherited from class javax.servlet.http.HttpServlet
doDelete, doGet, doHead, doOptions, doPut, doTrace, getLastModified, service, service

Methods inherited from class javax.servlet.GenericServlet
destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, log, log

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AdminServiceImpl
```
public AdminServiceImpl()
```
- Method Detail
  - getServerName
```
public java.lang.String getServerName()
```
    Returns the server's name.
    
    Specified by:
    
    getServerName in interface AdminService
    
    Returns:
    
    This server's name
  - isMaster
```
public boolean isMaster()
```
    Tells whether the server can modify the directory. Only the master server can. The others have read-only access to the directory.
    
    Specified by:
    
    isMaster in interface AdminService
    
    Returns:
    
    true if it can
  - setTargetLive
```
public int setTargetLive(boolean stayCurrent)
```
    Sets the live server's directory as the target.
    
    Specified by:
    
    setTargetLive in interface AdminService
    
    Parameters:
    
    stayCurrent - if true, all operations affect the most current generation of the security cache, otherwise they affect the generation attached to the admin session
    
    Returns:
    
    security cache generation serial number
  - setTargetFile
```
public boolean setTargetFile(java.lang.String name,
                             boolean create)
```
    Sets the specified directory file as the offline target. The file can't be the live directory file.
    
    Specified by:
    
    setTargetFile in interface AdminService
    
    Parameters:
    
    name - name of a directory file to use as the target
    
    create - true means a new directory file should be created, otherwise the named directory file should exist.
    
    Returns:
    
    true if the new target was set successfully
  - targetRefresh
```
public int targetRefresh()
```
    Refreshes the current security cache if the target is the live directory and only if there were changes performed since the last call to the targetRefresh().
    
    Specified by:
    
    targetRefresh in interface AdminService
    
    Returns:
    
    Security cache generation number. The same number as before means the cache was not refreshed.
  - isRefreshPending
```
public boolean isRefreshPending()
```
    Check if there is pending security cache refresh.
    
    Specified by:
    
    isRefreshPending in interface AdminService
    
    Returns:
    
    true if refresh is pending and false is there is no pending refresh or current user has not enough rights to perform it.
  - canRefresh
```
public boolean canRefresh()
```
    Check if current user can perform a refresh.
    
    Specified by:
    
    canRefresh in interface AdminService
    
    Returns:
    
    true user has enough rights to perform refresh.
  - getMessages
```
public java.lang.String[][] getMessages(boolean all)
```
    Returns an array of messages accumulated since the previous call or all messages since the last message cleanup. Messages can be retrieved multiple times. New messages are moved to the saved messages category after the first retrieval.
    
    Specified by:
    
    getMessages in interface AdminService
    
    Parameters:
    
    all - if true, then old and new messages are retrieved, otherwise new messages only
    
    Returns:
    
    array of messages, that can be empty
  - peekMessage
```
public java.lang.String peekMessage()
```
    Returns the most recent server message without changing its state on the server.
    
    Specified by:
    
    peekMessage in interface AdminService
    
    Returns:
    
    message or null if nothing is generated
  - clearMessages
```
public void clearMessages()
```
    Clears the old messages saved on the server, if any. New messages are not affected and will be returned with the next call to getMessages().
    
    Specified by:
    
    clearMessages in interface AdminService
  - getAdminDef
```
public AdminDef getAdminDef()
```
    Returns the configuration information about the administration interface itself. This information should be used to get access to the custom admin extensions
    
    Specified by:
    
    getAdminDef in interface AdminService
    
    Returns:
    
    container with admin related configuration information
  - getProfile
```
public AdminProfile[] getProfile(java.lang.String[] name)
```
    Returns the admin permissions profile for an arbitrary set of resource instance names.
    
    Specified by:
    
    getProfile in interface AdminService
    
    Parameters:
    
    name - array of admin non-leaf resource instance names to query
    
    Returns:
    
    permissions for the given names or null
  - getProfile
```
public AdminProfile[] getProfile(java.lang.String name,
                                 int[] perm)
```
    Returns the admin permissions profile for an arbitrary set of permissions for a resource instance name.
    
    Specified by:
    
    getProfile in interface AdminService
    
    Parameters:
    
    name - admin leaf resource instance name to query
    
    perm - array of permissions to query
    
    Returns:
    
    permissions for the given name or null
  - backupDirectory
```
public boolean backupDirectory(java.lang.String newfile)
```
    Backup the directory into a new file.
    
    Specified by:
    
    backupDirectory in interface AdminService
    
    Parameters:
    
    newfile - name of a backup file to create
    
    Returns:
    
    true if backup was successful.
  - lockForRereadDir
```
public boolean lockForRereadDir(int seconds)
```
    Lock directory for rereading from the file.
    
    Specified by:
    
    lockForRereadDir in interface AdminService
    
    Parameters:
    
    seconds - Seconds to wait before lock will expire.
    
    Returns:
    
    true if lock was successful.
  - rereadDirectory
```
public int rereadDirectory()
```
    Reread the directory file into the backend's cache after obtaining a refresh lock.
    Specified by:
    
    rereadDirectory in interface AdminService
    
    Returns:
    error code. Following error codes are possible:
    
    AdminConstants.ERR_NO_LOCK - is returned when no lock is present
    
    AdminConstants.ERR_LOCK_EXPIRED- is returned if lock is present but it is expired or belongs to other thread.
    
    AdminConstants.ERR_CANT_REFRESH_BACKEND - is returned when backend can't update directory.
    
    AdminConstants.ERR_ILLEGAL - is returned when no rights etc
  - cancelRereadDir
```
public void cancelRereadDir()
```
    Cancel (possibly) planned refreshing operation.
    
    Specified by:
    
    cancelRereadDir in interface AdminService
  - getSessionList
```
public SessionInfo[] getSessionList()
```
    Creates a report of all current user and process sessions.
    
    Specified by:
    
    getSessionList in interface AdminService
    
    Returns:
    
    Session descriptors suitable for reporting purposes or null if insufficient rights exist to obtain the list.
  - terminateSession
```
public void terminateSession(int sid)
```
    Forcibly terminate the specified session.
    
    Specified by:
    
    terminateSession in interface AdminService
    
    Parameters:
    
    sid - Session identifier.
  - getRecordLockList
```
public RecordLockInfo[] getRecordLockList()
```
    Creates a report of all record locks for the server.
    
    Specified by:
    
    getRecordLockList in interface AdminService
    
    Returns:
    
    Record lock descriptors suitable for reporting purposes or null if insufficient rights exist to obtain the list.
  - getDatabases
```
public java.lang.String[] getDatabases()
```
    Get the list of databases managed by this P2J server.
    
    Specified by:
    
    getDatabases in interface AdminService
    
    Returns:
    
    Names of databases managed by this P2J server.
  - getDatabaseTables
```
public java.lang.String[] getDatabaseTables(java.lang.String database)
```
    Get the list of tables of the given database.
    
    Specified by:
    
    getDatabaseTables in interface AdminService
    
    Parameters:
    
    database - Target database.
    
    Returns:
    
    See above. Names of the tables of the given database.
  - lockRecords
```
public boolean lockRecords(RecordInfo[] records)
```
    Lock the specified records. Locks are obtained in a single batch.
    You can unlock records using unlockRecords().
    
    Specified by:
    
    lockRecords in interface AdminService
    
    Parameters:
    
    records - Records to lock.
    
    Returns:
    
    true if records were successfully locked.
  - getLockRecords
```
public RecordInfo[] getLockRecords()
```
    Gets the records which have been previously locked in the given context using lockRecords(com.goldencode.p2j.admin.RecordInfo[]).
    
    Specified by:
    
    getLockRecords in interface AdminService
    
    Returns:
    
    Locked records in the given context.
  - unlockRecords
```
public boolean unlockRecords()
```
    Unlock the records which has been previously locked in the given context using lockRecords(com.goldencode.p2j.admin.RecordInfo[]).
    
    Specified by:
    
    unlockRecords in interface AdminService
    
    Returns:
    
    true if records were successfully unlocked.
  - shutdown
```
public boolean shutdown()
```
    Shuts the server down.
    
    Specified by:
    
    shutdown in interface AdminService
    
    Returns:
    
    true if successful
  - listResourceNames
```
public java.lang.String[] listResourceNames()
```
    Returns an array of resource plugin names.
    
    Specified by:
    
    listResourceNames in interface AdminService
    
    Returns:
    
    All defined resource plugin names
  - getResourceType
```
public java.lang.String getResourceType(java.lang.String name)
```
    Returns the registered resource type name for the given resource plugin.
    
    Specified by:
    
    getResourceType in interface AdminService
    
    Parameters:
    
    name - plugin name
    
    Returns:
    
    registered resource type name or null if no match
  - changeResourceNames
```
public boolean changeResourceNames(java.lang.String[] additions,
                                   java.lang.String[] deletions)
```
    Modifies resource name definitions.
    
    Specified by:
    
    changeResourceNames in interface AdminService
    
    Parameters:
    
    additions - array of resource names to add or null if no additions are specified
    
    deletions - array of resource names to delete or null if no deletions are specified
    
    Returns:
    
    boolean success indicator
  - getAuthConfig
```
public AuthConfigDef getAuthConfig()
```
    Gets authentication configuration, which includes authentication mode, password aging and security tracing level.
    
    Specified by:
    
    getAuthConfig in interface AdminService
    
    Returns:
    
    an instance with all current authentication values
  - setAuthConfig
```
public boolean setAuthConfig(AuthConfigDef authConfig)
```
    Sets authentication configuration from the specified instance, which includes authentication mode, password aging and security tracing level.
    
    Specified by:
    
    setAuthConfig in interface AdminService
    
    Parameters:
    
    authConfig - an instance loaded with the required configuration
    
    Returns:
    
    boolean success indicator
  - fromDTO
```
private date[] fromDTO(java.util.Date[] dts)
```
    Converts java.util.Date[], the array of data transferable objects, into the array of com.goldencode.p2j.util.date objects.
    
    Parameters:
    
    dts - The array of data transferable objects representing by java.util.Date
    
    Returns:
    
    The array of com.goldencode.p2j.util.date objects
  - toDTO
```
private java.util.Date[] toDTO(date[] dts)
```
    Converts com.goldencode.p2j.util.date[] to the array of java.util.Date data transferable objects.
    
    Parameters:
    
    dts - The array of com.goldencode.p2j.util.date objects
    
    Returns:
    
    dto object.
  - listHolidays
```
public java.util.Date[] listHolidays()
```
    Returns an array of defined holidays.
    
    Specified by:
    
    listHolidays in interface AdminService
    
    Returns:
    
    All defined holidays
  - changeHolidays
```
public boolean changeHolidays(java.util.Date[] additions,
                              java.util.Date[] deletions)
```
    Modifies defined holidays.
    
    Specified by:
    
    changeHolidays in interface AdminService
    
    Parameters:
    
    additions - array of dates to add or null if no additions are specified
    
    deletions - array of dates to delete or null if no deletions are specified
    
    Returns:
    
    boolean success indicator
  - getAudit
```
public AuditDef getAudit()
```
    Gets the audit.
    
    Specified by:
    
    getAudit in interface AdminService
    
    Returns:
    
    The audit
  - setAudit
```
public boolean setAudit(AuditDef audit)
```
    Sets the audit.
    
    Specified by:
    
    setAudit in interface AdminService
    
    Parameters:
    
    audit - The audit
    
    Returns:
    
    True, iff this action is completed successfully
  - listGroups
```
public TaggedName[] listGroups()
```
    Returns an array of defined group names.
    
    Specified by:
    
    listGroups in interface AdminService
    
    Returns:
    
    All defined group accounts or null
  - checkGroup
```
public TaggedName checkGroup(java.lang.String name)
```
    Check the group account existence.
    
    Specified by:
    
    checkGroup in interface AdminService
    
    Parameters:
    
    name - group name
    
    Returns:
    
    minimum group information (name, description) or null if the named group does not exist
  - getGroup
```
public GroupDef getGroup(java.lang.String name)
```
    Returns the group definition for the specified group name.
    
    Specified by:
    
    getGroup in interface AdminService
    
    Parameters:
    
    name - group name
    
    Returns:
    
    group definition or null if no such group
  - setGroup
```
public boolean setGroup(GroupDef group)
```
    Changes the group definition for the named group.
    
    Specified by:
    
    setGroup in interface AdminService
    
    Parameters:
    
    group - group definition
    
    Returns:
    
    true if successfully changed the group
  - addGroup
```
public boolean addGroup(GroupDef group)
```
    Adds new group account definition.
    
    Specified by:
    
    addGroup in interface AdminService
    
    Parameters:
    
    group - group definition for a new account
    
    Returns:
    
    true if successfully added the group
  - deleteGroup
```
public boolean deleteGroup(java.lang.String name)
```
    Deletes a group account definition. The account is deleted. All references to this group are deleted from the user accounts and from ACLs.
    
    Specified by:
    
    deleteGroup in interface AdminService
    
    Parameters:
    
    name - group name for the group being deleted
    
    Returns:
    
    true if successfully deleted the group
  - cloneGroup
```
public boolean cloneGroup(java.lang.String nameFrom,
                          java.lang.String nameTo,
                          boolean acls)
```
    Clones an existing group account into a new one. Users of the source group become also the users of the clone. ACLs are modified to give the source group's rights to the clone, if this option is requested.
    
    Specified by:
    
    cloneGroup in interface AdminService
    
    Parameters:
    
    nameFrom - group name for the source group
    
    nameTo - group name for the clone
    
    acls - true tells to clone ACLs as well
    
    Returns:
    
    true if successfully cloned the group
  - listGroupUsers
```
public TaggedName[] listGroupUsers(java.lang.String name)
```
    Enumerates the users of a named group.
    
    Specified by:
    
    listGroupUsers in interface AdminService
    
    Parameters:
    
    name - group name
    
    Returns:
    
    array of user names, that may be empty, or null if there is no such group
  - changeGroupUsers
```
public boolean changeGroupUsers(java.lang.String name,
                                java.lang.String[] additions,
                                java.lang.String[] deletions)
```
    Changes the group by adding and/or removing users.
    
    Specified by:
    
    changeGroupUsers in interface AdminService
    
    Parameters:
    
    name - group name
    
    additions - array of user names to be added to the group; may be empty
    
    deletions - array of user names to be excluded from the group; may be empty
    
    Returns:
    
    true if successfully changed the group
  - listUsers
```
public TaggedName[] listUsers()
```
    Returns an array of defined user account names and their owners.
    
    Specified by:
    
    listUsers in interface AdminService
    
    Returns:
    
    All defined user accounts or null
  - checkUser
```
public TaggedName checkUser(java.lang.String name)
```
    Check the user account existence.
    
    Specified by:
    
    checkUser in interface AdminService
    
    Parameters:
    
    name - user account name
    
    Returns:
    
    minimum user account information (name, person) or null if the named account does not exist
  - getUser
```
public UserDef getUser(java.lang.String name)
```
    Returns the user account definition for the specified account name.
    
    Specified by:
    
    getUser in interface AdminService
    
    Parameters:
    
    name - user account name
    
    Returns:
    
    user account definition or null if no such user
  - setUser
```
public boolean setUser(UserDef user)
```
    Changes the user account definition for the named account. Optional fields are synchronized with the directory. Password aging information is set only if a password is set. Any existing custom account extensions remain unchanged.
    
    Specified by:
    
    setUser in interface AdminService
    
    Parameters:
    
    user - user account definition
    
    Returns:
    
    true if successfully changed the account
  - setUser
```
public boolean setUser(UserDef user,
                       java.io.Serializable ext)
```
    Changes the user account definition for the named account. Optional fields are synchronized with the directory. Password aging information is set only if a password is set.
    
    Specified by:
    
    setUser in interface AdminService
    
    Parameters:
    
    user - user account definition
    
    ext - optional extension container for custom account extensions
    
    Returns:
    
    true if successfully changed the account
  - addUser
```
public boolean addUser(UserDef user,
                       java.io.Serializable ext)
```
    Adds new user account definition.
    
    Specified by:
    
    addUser in interface AdminService
    
    Parameters:
    
    user - user account definition
    
    ext - optional extension container for custom account extensions
    
    Returns:
    
    true if successfully added the account
  - deleteUser
```
public boolean deleteUser(java.lang.String name)
```
    Deletes a user account definition. The account is deleted. All references to this account are deleted from the ACLs, but the associated user certificate is left untouched.
    
    Specified by:
    
    deleteUser in interface AdminService
    
    Parameters:
    
    name - user account name being deleted
    
    Returns:
    
    true if successfully deleted the account
  - cloneUser
```
public boolean cloneUser(java.lang.String nameFrom,
                         java.lang.String nameTo,
                         boolean acls)
```
    Clones an existing user account into a new one, password included. ACLs are modified to give the source user rights to the clone, if this option is requested.
    
    Specified by:
    
    cloneUser in interface AdminService
    
    Parameters:
    
    nameFrom - user account name for the source
    
    nameTo - user account name for the clone
    
    acls - true tells to clone ACLs as well
    
    Returns:
    
    true if successfully cloned the user account
  - getOsUser
```
public OsUserDef getOsUser(java.lang.String name)
```
    Returns the OS user account definition for the specified account name.
    
    Specified by:
    
    getOsUser in interface AdminService
    
    Parameters:
    
    name - OS user account name
    
    Returns:
    
    OS user account definition or null if no such user
  - deleteOsUser
```
public boolean deleteOsUser(java.lang.String name)
```
    Deletes an OS user account definition. The account is deleted. All references to this account are deleted from the ACLs, but the associated user certificate is left untouched.
    
    Specified by:
    
    deleteOsUser in interface AdminService
    
    Parameters:
    
    name - OS user account name being deleted
    
    Returns:
    
    true if successfully deleted the account
  - addOsUser
```
public boolean addOsUser(OsUserDef user)
```
    Adds the OS user.
    
    Specified by:
    
    addOsUser in interface AdminService
    
    Parameters:
    
    user - the user
    
    Returns:
    
    true if successfully added the user
  - setOsUser
```
public boolean setOsUser(OsUserDef user)
```
    Sets the OS user.
    
    Specified by:
    
    setOsUser in interface AdminService
    
    Parameters:
    
    user - the user
    
    Returns:
    
    true if successfully changed the user
  - listAssociatedFwdUsers
```
public TaggedName[] listAssociatedFwdUsers(java.lang.String osUser)
```
    Returns an array of defined FWD user names, associated with the OS user.
    
    Specified by:
    
    listAssociatedFwdUsers in interface AdminService
    
    Parameters:
    
    osUser - The OS user name
    
    Returns:
    
    The associated FWD users or null
  - cloneUser
```
public boolean cloneUser(java.lang.String nameFrom,
                         java.lang.String nameTo,
                         boolean acls,
                         java.lang.String newPassword)
```
    Clones an existing user account into a new one and assigns the provided password to the clone. ACLs are modified to give the source user rights to the clone, if this option is requested.
    
    Specified by:
    
    cloneUser in interface AdminService
    
    Parameters:
    
    nameFrom - user account name for the source
    
    nameTo - user account name for the clone
    
    acls - true tells to clone ACLs as well
    
    newPassword - a replacement password for the clone
    
    Returns:
    
    true if successfully cloned the user account
  - listUserGroups
```
public TaggedName[] listUserGroups(java.lang.String name)
```
    Enumerates the groups the named user is part of.
    
    Specified by:
    
    listUserGroups in interface AdminService
    
    Parameters:
    
    name - user account name
    
    Returns:
    
    array of tagged group names, that may be empty, or null if there is no such user etc
  - listOsUsers
```
public TaggedName[] listOsUsers()
```
    Returns an array of defined OS user names and their hashed passwords.
    
    Specified by:
    
    listOsUsers in interface AdminService
    
    Returns:
    
    All defined OS users or null
  - checkOsUser
```
public TaggedName checkOsUser(java.lang.String name)
```
    Check the user account existence.
    
    Specified by:
    
    checkOsUser in interface AdminService
    
    Parameters:
    
    name - Os user account name
    
    Returns:
    
    Minimum OS user account information or null if the account doesn't exist
  - listProcesses
```
public TaggedName[] listProcesses()
```
    Returns an array of defined process names with their descriptions.
    
    Specified by:
    
    listProcesses in interface AdminService
    
    Returns:
    
    All defined processes accounts or null
  - checkProcess
```
public TaggedName checkProcess(java.lang.String name)
```
    Check the process account existence.
    
    Specified by:
    
    checkProcess in interface AdminService
    
    Parameters:
    
    name - process account name
    
    Returns:
    
    minimum process account information (name, description) or null if the named account does not exist
  - getProcess
```
public ProcessDef getProcess(java.lang.String name)
```
    Returns the process definition for the specified process name.
    
    Specified by:
    
    getProcess in interface AdminService
    
    Parameters:
    
    name - process name
    
    Returns:
    
    process definition or null if no such process
  - setProcess
```
public boolean setProcess(ProcessDef process)
```
    Changes the process definition for the named process. Any existing custom account extensions remain unchanged.
    
    Specified by:
    
    setProcess in interface AdminService
    
    Parameters:
    
    process - process definition
    
    Returns:
    
    true if successfully changed the process
  - setProcess
```
public boolean setProcess(ProcessDef process,
                          java.io.Serializable ext)
```
    Changes the process definition for the named process.
    
    Specified by:
    
    setProcess in interface AdminService
    
    Parameters:
    
    process - process definition
    
    ext - optional extension container for custom account extensions
    
    Returns:
    
    true if successfully changed the process
  - addProcess
```
public boolean addProcess(ProcessDef process,
                          java.io.Serializable ext)
```
    Adds new process account definition.
    
    Specified by:
    
    addProcess in interface AdminService
    
    Parameters:
    
    process - process definition for a new account
    
    ext - optional extension container for custom account extensions
    
    Returns:
    
    true if successfully added the process
  - deleteProcess
```
public boolean deleteProcess(java.lang.String name)
```
    Deletes a process account definition. The account is deleted. All references to this process are deleted from the ACLs, but the associated process certificate is left untouched.
    
    Specified by:
    
    deleteProcess in interface AdminService
    
    Parameters:
    
    name - process account name being deleted
    
    Returns:
    
    true if successfully deleted the process
  - cloneProcess
```
public boolean cloneProcess(java.lang.String nameFrom,
                            java.lang.String nameTo,
                            boolean acls)
```
    Clones an existing process account into a new one. Master server flag is always false for the clone. ACLs are modified to give the source process' rights to the clone, if this option is requested.
    
    Specified by:
    
    cloneProcess in interface AdminService
    
    Parameters:
    
    nameFrom - process name for the source
    
    nameTo - process name for the clone
    
    acls - true tells to clone ACLs as well
    
    Returns:
    
    true if successfully cloned the process
  - listAuthCerts
```
public TaggedName[] listAuthCerts(boolean unusedOnly)
```
    Returns an array of defined Certificate Authority certificates with their distinctive names.
    
    Specified by:
    
    listAuthCerts in interface AdminService
    
    Parameters:
    
    unusedOnly - if true, lists unused certificates only, otherwise all certificates
    
    Returns:
    
    All defined CA certificates or null
  - listPeerCerts
```
public TaggedName[] listPeerCerts(boolean unusedOnly)
```
    Returns an array of defined peer (non-CA) certificates with their distinctive names.
    
    Specified by:
    
    listPeerCerts in interface AdminService
    
    Parameters:
    
    unusedOnly - if true, lists unused certificates only, otherwise all certificates
    
    Returns:
    
    All defined peer certificates or null
  - getCertUsers
```
public TaggedName[] getCertUsers(java.lang.String alias)
```
    Returns an array of user account names with their description for users sharing this certificate.
    
    Specified by:
    
    getCertUsers in interface AdminService
    
    Parameters:
    
    alias - certificate alias name
    
    Returns:
    
    all user accounts referring to this certificate or null
  - getCertProcesses
```
public TaggedName[] getCertProcesses(java.lang.String alias)
```
    Returns an array of process account names with their description for processes sharing this certificate.
    
    Specified by:
    
    getCertProcesses in interface AdminService
    
    Parameters:
    
    alias - certificate alias name
    
    Returns:
    
    all process accounts referring to this certificate or null
  - getCertAccounts
```
public TaggedName[] getCertAccounts(java.lang.String alias)
```
    Returns an array of all account names with their description for accounts sharing this certificate.
    
    Specified by:
    
    getCertAccounts in interface AdminService
    
    Parameters:
    
    alias - certificate alias name
    
    Returns:
    
    all accounts referring to this certificate or null
  - getCert
```
public CertDef getCert(java.lang.String alias)
```
    Returns a DER-encoded certificate like those found in *.PEM files.
    
    Specified by:
    
    getCert in interface AdminService
    
    Parameters:
    
    alias - the alias of the certificate to get
    
    Returns:
    
    the encoded certificate or null
  - setCert
```
public boolean setCert(CertDef cert)
```
    Replaces an existing certificate with the given one.
    
    Specified by:
    
    setCert in interface AdminService
    
    Parameters:
    
    cert - encoded certificate
    
    Returns:
    
    true if replaced, false if errors
  - addCert
```
public boolean addCert(CertDef cert)
```
    Adds a new certificate according to its definition.
    
    Specified by:
    
    addCert in interface AdminService
    
    Parameters:
    
    cert - encoded certificate
    
    Returns:
    
    true if added, false if errors
  - moveCert
```
public boolean moveCert(java.lang.String aliasFrom,
                        java.lang.String aliasTo)
```
    Changes the certificate's alias.
    
    Specified by:
    
    moveCert in interface AdminService
    
    Parameters:
    
    aliasFrom - current certificate's alias
    
    aliasTo - new certificate's alias
    
    Returns:
    
    true if changed, false if errors
  - searchCert
```
public java.lang.String searchCert(java.lang.String dn)
```
    Searches the CA directory for an alias of the certificate by the distinctive name of the subject.
    
    Specified by:
    
    searchCert in interface AdminService
    
    Parameters:
    
    dn - distinctive name
    
    Returns:
    
    alias of the certificate if exists, or null.
  - deleteCert
```
public boolean deleteCert(java.lang.String alias,
                          boolean force)
```
    Deletes an existing certificate conditionally or unconditionally.
    
    Specified by:
    
    deleteCert in interface AdminService
    
    Parameters:
    
    alias - the alias of the certificate being deleted
    
    force - if true, the certificate is deleted even if in use
    
    Returns:
    
    true if deleted, false if errors
  - listAclInstances
```
public java.lang.String[] listAclInstances()
```
    Locates all instances of ACLs in the directory and returns their names. The shared instance has an empty name.
    ACL instances are the directory branches that store ACLs. The shared instance is the one found under /security/acl branch. Private instances are found under /security/acls/name branches.
    
    Specified by:
    
    listAclInstances in interface AdminService
    
    Returns:
    
    array of ACL instance names; may be empty
  - listAclInstances
```
public java.lang.String[] listAclInstances(java.lang.String resourceType)
```
    Locates all instances of ACLs in the directory and returns their names for those instances which have ACLs defined for the specified resource type. The shared instance has an empty name.
    ACL instances are the directory branches that store ACLs. The shared instance is the one found under /security/acl branch. Private instances are found under /security/acls/name branches.
    
    Specified by:
    
    listAclInstances in interface AdminService
    
    Parameters:
    
    resourceType - name of the resource of interest
    
    Returns:
    
    array of ACL instance names; may be empty
  - listInstanceAcls
```
public java.lang.String[] listInstanceAcls(java.lang.String instanceName)
```
    Lists resource names for which the specified ACL instance has ACLs defined.
    
    Specified by:
    
    listInstanceAcls in interface AdminService
    
    Parameters:
    
    instanceName - name of the ACL instance; empty string for the shared one
    
    Returns:
    
    array of resource type names; may be empty
  - getAcl
```
public AclDef getAcl(java.lang.String resourceType,
                     java.lang.String instanceName)
```
    Gets the full ACL definition information from the directory for the specified ACL instance and resource type.
    
    Specified by:
    
    getAcl in interface AdminService
    
    Parameters:
    
    resourceType - name of the resource of interest; can't be null
    
    instanceName - name of the ACL instance; empty string for the shared one; can't be null
    
    Returns:
    
    ACL definition or null
  - getAllAcls
```
public AclDef[] getAllAcls(java.lang.String instanceName)
```
    Gets the full ACL definition information from the directory for the specified ACL instance or all of them.
    
    Specified by:
    
    getAllAcls in interface AdminService
    
    Parameters:
    
    instanceName - name of the ACL instance; empty string for the shared one; if null, all ACLs are returned and some may be combined
    
    Returns:
    
    an array of ACL definitions, one per resource type and instance, or null
  - getEffectiveAcls
```
public AclDef getEffectiveAcls(java.lang.String resourceType)
```
    Gets the combined ACL definition information from the directory for the specified resource type. The combination is done according to the regular server's rules taking the private instance for the live server and the shared one.
    
    Specified by:
    
    getEffectiveAcls in interface AdminService
    
    Parameters:
    
    resourceType - name of the resource of interest; can't be null
    
    Returns:
    
    ACL definition or null
  - addAcl
```
public boolean addAcl(java.lang.String resourceType,
                      Acl acl,
                      java.util.Map<java.lang.Integer,java.lang.String> subjMap)
```
    Adds new set of ACLs based on the contents of the given ACL definition. Both the target ACL instance and resource part will be created if they don't exist.
    
    Specified by:
    
    addAcl in interface AdminService
    
    Parameters:
    
    resourceType - name of the resource to add the ACL for
    
    acl - ACL definition, that should come fully defined, including the instance name.
    
    subjMap - a map to translate numeric subject IDs back to names
    
    Returns:
    
    true if added, false if errors
  - setAcl
```
public boolean setAcl(java.lang.String resourceType,
                      Acl acl,
                      java.util.Map<java.lang.Integer,java.lang.String> subjMap,
                      boolean setInstance,
                      boolean setInstanceMode,
                      boolean setSubjects,
                      boolean setRights)
```
    Conditionally edits the existing ACL based on the contents of the given ACL and the selected conditions.
    
    Specified by:
    
    setAcl in interface AdminService
    
    Parameters:
    
    resourceType - name of the resource to set the ACL for
    
    acl - ACL definition
    
    subjMap - a map to translate numeric subject IDs back to names; needed only when setSubjects is true and can be null all other times
    
    setInstance - true if setting the resource instance name
    
    setInstanceMode - true if setting the resource instance name mode
    
    setSubjects - true if setting the subjects IDs
    
    setRights - true if setting the rights for this ACL
    
    Returns:
    
    true if set, false if errors
  - moveAcl
```
public boolean moveAcl(java.lang.String resourceType,
                       java.lang.String instanceName,
                       int oid,
                       java.lang.String newInstanceName)
```
    Moves the specified ACL to another ACL instance, private or shared. The target instance will be created, if it doesn't exist.
    
    Specified by:
    
    moveAcl in interface AdminService
    
    Parameters:
    
    resourceType - name of the resource of interest
    
    instanceName - name of the source ACL instance; empty string for the shared one
    
    oid - ACL object ID that selects the ACL to move
    
    newInstanceName - name of the target ACL instance; empty string for the shared one
    
    Returns:
    
    true if moved, false if errors
  - moveAcl
```
public boolean moveAcl(java.lang.String resourceType,
                       java.lang.String instanceName,
                       int oid,
                       int newOid)
```
    Moves the specified ACL to another position within the same ACL instance.
    
    Specified by:
    
    moveAcl in interface AdminService
    
    Parameters:
    
    resourceType - name of the resource of interest
    
    instanceName - name of the source ACL instance; empty string for the shared one
    
    oid - ACL object ID that selects the ACL to move
    
    newOid - new ACL object ID
    
    Returns:
    
    true if moved, false if errors
  - deleteAcl
```
public boolean deleteAcl(java.lang.String resourceType,
                         java.lang.String instanceName,
                         int oid)
```
    Deletes the specified ACL from the specified ACL instance.
    
    Specified by:
    
    deleteAcl in interface AdminService
    
    Parameters:
    
    resourceType - name of the resource of interest
    
    instanceName - name of the source ACL instance; empty string for the shared one
    
    oid - ACL object ID that selects the ACL to delete
    
    Returns:
    
    true if deleted, false if errors
  - cloneAcl
```
public boolean cloneAcl(java.lang.String resourceType,
                        java.lang.String instanceName,
                        int oid,
                        int cloneOid)
```
    Clones the specified ACL to another position within the same ACL instance.
    
    Specified by:
    
    cloneAcl in interface AdminService
    
    Parameters:
    
    resourceType - name of the resource of interest
    
    instanceName - name of the source ACL instance; empty string for the shared one
    
    oid - ACL object ID that selects the ACL to clone
    
    cloneOid - ACL object ID for the clone
    
    Returns:
    
    true if cloned, false if errors
  - resequenceAcls
```
public boolean resequenceAcls(java.lang.String resourceType,
                              java.lang.String instanceName,
                              int start,
                              int step)
```
    Assigns new object IDs sequentially for all ACLs in the given ACL instance and resource type.
    
    Specified by:
    
    resequenceAcls in interface AdminService
    
    Parameters:
    
    resourceType - name of the resource of interest
    
    instanceName - name of the source ACL instance; empty string for the shared one
    
    start - the starting number
    
    step - the increment
    
    Returns:
    
    true if success, false if errors
  - addAclInstance
```
public boolean addAclInstance(java.lang.String instanceName)
```
    Creates an empty container for the specified ACL instance. The instance should not exist.
    
    Specified by:
    
    addAclInstance in interface AdminService
    
    Parameters:
    
    instanceName - name of the ACL instance; empty string for the shared one
    
    Returns:
    
    true if created, false if errors
  - deleteAclInstance
```
public boolean deleteAclInstance(java.lang.String instanceName)
```
    Deletes entire ACL instance from the directory. The instance should exist.
    
    Specified by:
    
    deleteAclInstance in interface AdminService
    
    Parameters:
    
    instanceName - name of the ACL instance; empty string for the shared one
    
    Returns:
    
    true if deleted, false if errors
  - deleteAclInstance
```
public boolean deleteAclInstance(java.lang.String resourceType,
                                 java.lang.String instanceName)
```
    Deletes the resource specific part of an ACL instance from the directory. The instance and the resource part should exist.
    
    Specified by:
    
    deleteAclInstance in interface AdminService
    
    Parameters:
    
    resourceType - name of the resource of interest
    
    instanceName - name of the ACL instance; empty string for the shared one
    
    Returns:
    
    true if deleted, false if errors
  - cloneAclInstance
```
public boolean cloneAclInstance(java.lang.String instanceFrom,
                                java.lang.String instanceTo)
```
    Clones entire ACL instance. The source ACL instance should exist. The target ACL instance should not exist.
    
    Specified by:
    
    cloneAclInstance in interface AdminService
    
    Parameters:
    
    instanceFrom - name of the source ACL instance; empty string for the shared one
    
    instanceTo - name of the target ACL instance; empty string for the shared one
    
    Returns:
    
    true if cloned, false if errors
  - cloneAclInstance
```
public boolean cloneAclInstance(java.lang.String resourceType,
                                java.lang.String instanceFrom,
                                java.lang.String instanceTo)
```
    Clones the resource specific part of an ACL instance. The source ACL instance and the resource part should exist. The target ACL instance should exist. The resource part in the target ACL instance should NOT exist.
    
    Specified by:
    
    cloneAclInstance in interface AdminService
    
    Parameters:
    
    resourceType - name of the resource of interest
    
    instanceFrom - name of the source ACL instance; empty string for the shared one
    
    instanceTo - name of the target ACL instance; empty string for the shared one
    
    Returns:
    
    true if cloned, false if errors
  - moveAclInstance
```
public boolean moveAclInstance(java.lang.String instanceFrom,
                               java.lang.String instanceTo)
```
    Moves entire ACL instance. The source ACL instance should exist. The target ACL instance should not exist.
    
    Specified by:
    
    moveAclInstance in interface AdminService
    
    Parameters:
    
    instanceFrom - name of the source ACL instance; empty string for the shared one
    
    instanceTo - name of the target ACL instance; empty string for the shared one
    
    Returns:
    
    true if moved, false if errors
  - moveAclInstance
```
public boolean moveAclInstance(java.lang.String resourceType,
                               java.lang.String instanceFrom,
                               java.lang.String instanceTo)
```
    Moves the resource specific part of an ACL instance. The source ACL instance and the resource part should exist. The target ACL instance should exist. The resource part in the target ACL instance should NOT exist.
    
    Specified by:
    
    moveAclInstance in interface AdminService
    
    Parameters:
    
    resourceType - name of the resource of interest
    
    instanceFrom - name of the source ACL instance; empty string for the shared one
    
    instanceTo - name of the target ACL instance; empty string for the shared one
    
    Returns:
    
    true if moved, false if errors
  - listServers
```
public java.lang.String[] listServers()
```
    Returns the list of all server instances found in the directory under the "/server" node. The "default" instance is returned as an empty string.
    
    Specified by:
    
    listServers in interface AdminService
    
    Returns:
    
    array of server names
  - listServers
```
public java.lang.String[] listServers(java.lang.String containers)
```
    Returns the list of server instances under the "/server" node, that have the specified container (or nested chain of) as a child.
    
    Specified by:
    
    listServers in interface AdminService
    
    Parameters:
    
    containers - one or more container names separated by "/"
    
    Returns:
    
    array of server names holding the named containers
  - listAuthPlugins
```
public TaggedName[] listAuthPlugins()
```
    Get the list of available auth plugins.
    
    Specified by:
    
    listAuthPlugins in interface AdminService
    
    Returns:
    
    the list of available auth plugins encoded into tagged names or null if no plugins are available.
  - bulkAuthModeUpdate
```
public int bulkAuthModeUpdate(int targetAccounts,
                              java.lang.String[] excludedAccounts,
                              int authMode,
                              java.lang.String authPlugin)
```
    Preforms bulk update of authentication settings of the accounts of the specified type.
    
    Specified by:
    
    bulkAuthModeUpdate in interface AdminService
    
    Parameters:
    
    targetAccounts - Type of accounts to update. Account.ACC_USER and Account.ACC_GROUP are supported.
    
    excludedAccounts - The list of IDs of the accounts that should NOT be updated. Can be null.
    
    authMode - Authentication mode to set.
    
    authPlugin - Authentication plugin to set.
    
    Returns:
    
    the number of updated accounts or -1 if an error has occured.
  - getRegisteredJars
```
public TaggedName[] getRegisteredJars()
```
    Get the list of registered jars (which represent customer libs).
    
    Specified by:
    
    getRegisteredJars in interface AdminService
    
    Returns:
    
    the list of registered jar, each returned TaggedName represents a single jar and contains jar file name, fully qualified class name of the active hook (it may be null) and value indicating whether active hook class matches stored hook class which is "true" if they match.
  - getUnregisteredJars
```
public java.lang.String[] getUnregisteredJars()
```
    Get the list of jars, which reside in the customer libs directory, but haven't been registered yet and do not present in the server classpath.
    
    Specified by:
    
    getUnregisteredJars in interface AdminService
    
    Returns:
    
    the list of the names of unregistered jar files available for registration.
  - getAvailableJarHookClasses
```
public java.lang.String[] getAvailableJarHookClasses(java.lang.String jar)
```
    Get the list of classes which reside into the specified jar file and implement the InitTermListener interface. These classes can be used as "hook" classes which should be called after the jar representing a customer lib was successfully registered, to initialize it.
    
    Specified by:
    
    getAvailableJarHookClasses in interface AdminService
    
    Parameters:
    
    jar - The name of the target jar file.
    
    Returns:
    
    the list of fully qualified names of the classes which reside into the specified jar and implement the InitTermListener interface.
  - getStoredJarHookClass
```
public java.lang.String getStoredJarHookClass(java.lang.String jar)
```
    Get hook class specified in the directory for the target jar.
    
    Specified by:
    
    getStoredJarHookClass in interface AdminService
    
    Parameters:
    
    jar - The name of the target jar file (should be loaded).
    
    Returns:
    
    fully qualified class name of the hook specified in the directory for the target jar or null if the jar has no hook specified.
  - registerJar
```
public JarOpErrorCode registerJar(java.lang.String jar,
                                  java.lang.String hookClass,
                                  boolean storeInDirectory)
```
    Register the specified jar file (which represent a customer lib). Also, a "hook" class can be registered for this jar, this class will be called after the jar was successfully registered, to initialize it.
    
    Specified by:
    
    registerJar in interface AdminService
    
    Parameters:
    
    jar - The name of the jar file to register.
    
    hookClass - Fully qualified name of the "hook" class for this jar, can be null.
    
    storeInDirectory - If true then the jar is registered in the directory, else only runtime registration is performed.
    
    Returns:
    
    operation result.
  - deregisterJar
```
public JarOpErrorCode deregisterJar(java.lang.String jar,
                                    boolean force,
                                    boolean removeFromDirectory)
```
    Remove registration for the specified jar.
    
    Specified by:
    
    deregisterJar in interface AdminService
    
    Parameters:
    
    jar - Jar file which registration should be removed.
    
    force - If it is true then any sessions that have executed API(s) associated to this jar are forcibly terminated. If this parameter is false then, if the jar has any sessions that have executed API(s) associated to it, the function returns JarOpErrorCode.ACTIVE_SESSIONS_PRESENT.
    
    removeFromDirectory - If true then the jar registration is removed from the directory, else only runtime deregistration is performed.
    
    Returns:
    
    operation result.
  - deregisterJarFromDirectory
```
public JarOpErrorCode deregisterJarFromDirectory(java.lang.String jar,
                                                 java.lang.String storedHookClass)
```
    Remove jar registration from the directory.
    
    Specified by:
    
    deregisterJarFromDirectory in interface AdminService
    
    Parameters:
    
    jar - The name of the jar to be deregistered.
    
    storedHookClass - The name of the hook class which is stored for this jar in the directory or null if no hook is defined for this jar.
    
    Returns:
    
    operation result code.
  - changeJarHookClass
```
public JarOpErrorCode changeJarHookClass(java.lang.String jar,
                                         java.lang.String hookClass)
```
    Change the server-wide or global hook class of the specific jar.
    
    Specified by:
    
    changeJarHookClass in interface AdminService
    
    Parameters:
    
    jar - The name of the target jar file.
    
    hookClass - The new hook class for the target jar. null indicates that no hook class should be specified.
    
    Returns:
    
    operation result.
  - getRegisteredJarAPIs
```
public TaggedName[] getRegisteredJarAPIs(java.lang.String jar)
```
    Get the list of APIs registered for the specified jar.
    
    Specified by:
    
    getRegisteredJarAPIs in interface AdminService
    
    Parameters:
    
    jar - The name of the target jar file.
    
    Returns:
    
    the list of APIs registered for the specified jar, each returned TaggedName represents a single API and contains fully qualified name of the interface and fully qualified name of the implementation class.
  - getAvailableJarAPIInterfaces
```
public java.lang.String[] getAvailableJarAPIInterfaces(java.lang.String jar,
                                                       boolean showRegistered)
```
    Get the list of interfaces available in the specified jar file.
    
    Specified by:
    
    getAvailableJarAPIInterfaces in interface AdminService
    
    Parameters:
    
    jar - The name of the target jar file.
    
    showRegistered - If true then resulting list contains interfaces that have already have been registered for an API for the given jar (assuming that each API is defined using an unique interface).
    
    Returns:
    
    the list of fully qualified names of interfaces available in the specified jar file.
  - getAvailableJarAPIImplClasses
```
public java.lang.String[] getAvailableJarAPIImplClasses(java.lang.String jar,
                                                        java.lang.String interfaceClass)
```
    Get the list of classes which reside in the specified jar and statically implement all methods defined by the specified interface.
    
    Specified by:
    
    getAvailableJarAPIImplClasses in interface AdminService
    
    Parameters:
    
    jar - The name of the target jar file.
    
    interfaceClass - Fully qualified name of the target interface.
    
    Returns:
    
    the list of fully qualified names of classes which reside in the specified jar and statically implement all methods defined by the specified interface.
  - registerJarAPI
```
public JarOpErrorCode registerJarAPI(java.lang.String interfaceClass,
                                     java.lang.String implementationClass)
```
    Register API specified by the given interface and implementation class.
    
    Specified by:
    
    registerJarAPI in interface AdminService
    
    Parameters:
    
    interfaceClass - Fully qualified name of the interface which defines the target API.
    
    implementationClass - Fully qualified name of the class which implements the target API.
    
    Returns:
    
    operation result.
  - deregisterJarAPI
```
public JarOpErrorCode deregisterJarAPI(java.lang.String jar,
                                       java.lang.String interfaceClass,
                                       boolean force)
```
    Remove registration of the specified API in the specified jar.
    
    Specified by:
    
    deregisterJarAPI in interface AdminService
    
    Parameters:
    
    jar - The name of the target jar file.
    
    interfaceClass - Fully qualified name of the interface which defines the target API.
    
    force - If it is true then any sessions that have executed the target API are forcibly terminated. If this parameter is false then, if the jar has any sessions that have executed API(s) associated to it, the function returns JarOpErrorCode.ACTIVE_SESSIONS_PRESENT.
    
    Returns:
    
    operation result.
  - changeJarHooksType
```
public JarOpErrorCode changeJarHooksType(boolean serverWide,
                                         boolean move)
```
    Make the current server use server-wide or global hooks, optionally copying or moving hooks from one scope to another.
    
    Specified by:
    
    changeJarHooksType in interface AdminService
    
    Parameters:
    
    serverWide - if true then server-wide hooks should be used, else global hooks should be used.
    
    move - if true then existing hooks are copied/moved from one scope to another, otherwise they don't.
    
    Returns:
    
    operation result.
  - getActiveSessions
```
public SessionInfo[] getActiveSessions(java.lang.String jar,
                                       java.lang.String apiInterfaceClass)
```
    Get the list of all active sessions which have executed the specified API or API(s) associated to the specified jar.
    
    Specified by:
    
    getActiveSessions in interface AdminService
    
    Parameters:
    
    jar - The name of the target jar file.
    
    apiInterfaceClass - Fully qualified name of the interface which defines the target API. Can be null if you want to get sessions of all APIs of the target jar.
    
    Returns:
    
    the list of all active sessions which have executed the specified API or API(s) associated to the specified jar.
  - isUsingServerWideHooks
```
public java.lang.Boolean isUsingServerWideHooks()
```
    Returns information whether server-wide or global hooks are used for the current server.
    
    Specified by:
    
    isUsingServerWideHooks in interface AdminService
    
    Returns:
    
    true if server-wide hooks are used, false if global hooks are used, null if you have insufficient access rights.
  - isUsingMultiClassLoader
```
public java.lang.Boolean isUsingMultiClassLoader()
```
    Allows to determine whether MultiClassLoader is used as the system class loader.
    
    Specified by:
    
    isUsingMultiClassLoader in interface AdminService
    
    Returns:
    
    true if MultiClassLoader is used as the system class loader, false if the standard class loader is used, null if you do not have enough permissions
  - getManagedLibsDirInformation
```
public TaggedName getManagedLibsDirInformation()
```
    Get information about managed libraries directory (path to it and information whether it exists).
    
    Specified by:
    
    getManagedLibsDirInformation in interface AdminService
    
    Returns:
    
    TaggedName which contains fully qualified path to the managed libraries directory and string value which is "true" if this directory exists and is accessible. If you do not have admin rights, null is returned.
  - listLoggingInstances
```
public java.lang.String[] listLoggingInstances()
```
    Description copied from interface: AdminService
    
    Returns the list of logging instances.
    
    Specified by:
    
    listLoggingInstances in interface AdminService
    
    Returns:
    
    The list of logging instances.
  - getLogging
```
public LoggingDef getLogging(java.lang.String name)
```
    Description copied from interface: AdminService
    
    Returns the logging definition by the given name.
    
    Specified by:
    
    getLogging in interface AdminService
    
    Parameters:
    
    name - The given name
    
    Returns:
    
    The target logging definition.
  - setLogging
```
public boolean setLogging(LoggingDef logging)
```
    Description copied from interface: AdminService
    
    Sets the logging definition.
    
    Specified by:
    
    setLogging in interface AdminService
    
    Parameters:
    
    logging - The logging definition
    
    Returns:
    
    boolean indicating the success of this operation.
  - addLogging
```
public boolean addLogging(java.lang.String name,
                          LoggingDef logging)
```
    Description copied from interface: AdminService
    
    Adds the logging definition for the given name
    
    Specified by:
    
    addLogging in interface AdminService
    
    Parameters:
    
    name - The given name
    
    logging - The logging definition
    
    Returns:
    
    boolean indicating the success of this operation.
  - cloneLogging
```
public boolean cloneLogging(java.lang.String nameFrom,
                            java.lang.String nameTo)
```
    Description copied from interface: AdminService
    
    Clones the logging definition from the source to the target.
    
    Specified by:
    
    cloneLogging in interface AdminService
    
    Parameters:
    
    nameFrom - The source name
    
    nameTo - The target name
    
    Returns:
    
    boolean indicating the success of this operation.
  - moveLogging
```
public boolean moveLogging(java.lang.String nameFrom,
                           java.lang.String nameTo)
```
    Description copied from interface: AdminService
    
    Moves the logging definition from the source to the target.
    
    Specified by:
    
    moveLogging in interface AdminService
    
    Parameters:
    
    nameFrom - The source name
    
    nameTo - The target name
    
    Returns:
    
    boolean indicating the success of this operation.
  - deleteLogging
```
public boolean deleteLogging(java.lang.String name)
```
    Description copied from interface: AdminService
    
    Deletes the logging definition of the given name.
    
    Specified by:
    
    deleteLogging in interface AdminService
    
    Parameters:
    
    name - The given name
    
    Returns:
    
    boolean indicating the success of this operation.
  - listExportsInstances
```
public java.lang.String[] listExportsInstances()
```
    Description copied from interface: AdminService
    
    Returns the list of export instances.
    
    Specified by:
    
    listExportsInstances in interface AdminService
    
    Returns:
    
    The string array of export instances.
  - getExports
```
public ExportsDef getExports(java.lang.String name)
```
    Description copied from interface: AdminService
    
    Returns the export definition by the given export instance name.
    
    Specified by:
    
    getExports in interface AdminService
    
    Parameters:
    
    name - The given export instance name
    
    Returns:
    
    The export definition
  - setExports
```
public boolean setExports(ExportsDef logging)
```
    Description copied from interface: AdminService
    
    Sets the export definition.
    
    Specified by:
    
    setExports in interface AdminService
    
    Parameters:
    
    logging - The export definition
    
    Returns:
    
    boolean indicating the success of this operation.
  - addExports
```
public boolean addExports(java.lang.String name,
                          ExportsDef logging)
```
    Description copied from interface: AdminService
    
    Adds the export definition for the given name
    
    Specified by:
    
    addExports in interface AdminService
    
    Parameters:
    
    name - The given name
    
    logging - The export definition
    
    Returns:
    
    boolean indicating the success of this operation.
  - cloneExports
```
public boolean cloneExports(java.lang.String nameFrom,
                            java.lang.String nameTo)
```
    Description copied from interface: AdminService
    
    Clones the export definition from the source to the target.
    
    Specified by:
    
    cloneExports in interface AdminService
    
    Parameters:
    
    nameFrom - The source name
    
    nameTo - The target name
    
    Returns:
    
    boolean indicating the success of this operation.
  - moveExports
```
public boolean moveExports(java.lang.String nameFrom,
                           java.lang.String nameTo)
```
    Description copied from interface: AdminService
    
    Moves the export definition from the source to the target.
    
    Specified by:
    
    moveExports in interface AdminService
    
    Parameters:
    
    nameFrom - The source name
    
    nameTo - The target name
    
    Returns:
    
    boolean indicating the success of this operation.
  - deleteExports
```
public boolean deleteExports(java.lang.String name)
```
    Description copied from interface: AdminService
    
    Deletes the export definition of the given name.
    
    Specified by:
    
    deleteExports in interface AdminService
    
    Parameters:
    
    name - The given name
    
    Returns:
    
    boolean indicating the success of this operation.
  - listStartupInstances
```
public java.lang.String[] listStartupInstances()
```
    Description copied from interface: AdminService
    
    Returns the list of startup instances.
    
    Specified by:
    
    listStartupInstances in interface AdminService
    
    Returns:
    
    The string array of startup instances.
  - getStartup
```
public StartupDef getStartup(java.lang.String name)
```
    Description copied from interface: AdminService
    
    Returns the startup definition by the given startup instance name.
    
    Specified by:
    
    getStartup in interface AdminService
    
    Parameters:
    
    name - The given startup instance name
    
    Returns:
    
    The startup definition
  - setStartup
```
public boolean setStartup(StartupDef startup)
```
    Description copied from interface: AdminService
    
    Sets the startup definition.
    
    Specified by:
    
    setStartup in interface AdminService
    
    Parameters:
    
    startup - The startup definition
    
    Returns:
    
    boolean indicating the success of this operation.
  - addStartup
```
public boolean addStartup(java.lang.String name,
                          StartupDef logging)
```
    Description copied from interface: AdminService
    
    Adds the startup definition for the given instance name
    
    Specified by:
    
    addStartup in interface AdminService
    
    Parameters:
    
    name - The given name
    
    logging - The startup definition
    
    Returns:
    
    boolean indicating the success of this operation.
  - cloneStartup
```
public boolean cloneStartup(java.lang.String nameFrom,
                            java.lang.String nameTo)
```
    Description copied from interface: AdminService
    
    Clones the startup definition from the source to the target.
    
    Specified by:
    
    cloneStartup in interface AdminService
    
    Parameters:
    
    nameFrom - The source name
    
    nameTo - The target name
    
    Returns:
    
    boolean indicating the success of this operation.
  - moveStartup
```
public boolean moveStartup(java.lang.String nameFrom,
                           java.lang.String nameTo)
```
    Description copied from interface: AdminService
    
    Moves the startup definition from the source to the target.
    
    Specified by:
    
    moveStartup in interface AdminService
    
    Parameters:
    
    nameFrom - The source name
    
    nameTo - The target name
    
    Returns:
    
    boolean indicating the success of this operation.
  - deleteStartup
```
public boolean deleteStartup(java.lang.String name)
```
    Description copied from interface: AdminService
    
    Deletes the startup definition of the given name.
    
    Specified by:
    
    deleteStartup in interface AdminService
    
    Parameters:
    
    name - The given name
    
    Returns:
    
    boolean indicating the success of this operation.
  - listPersistenceInstances
```
public java.lang.String[] listPersistenceInstances()
```
    Description copied from interface: AdminService
    
    Returns the list of persistence instances.
    
    Specified by:
    
    listPersistenceInstances in interface AdminService
    
    Returns:
    
    The string array of persistence instances.
  - getPersistence
```
public PersistenceDef getPersistence(java.lang.String name)
```
    Description copied from interface: AdminService
    
    Returns the persistence definition by the given persistence instance name.
    
    Specified by:
    
    getPersistence in interface AdminService
    
    Parameters:
    
    name - The given persistence instance name
    
    Returns:
    
    The persistence definition
  - setPersistence
```
public boolean setPersistence(PersistenceDef persistence)
```
    Description copied from interface: AdminService
    
    Sets the persistence definition.
    
    Specified by:
    
    setPersistence in interface AdminService
    
    Parameters:
    
    persistence - The persistence definition
    
    Returns:
    
    boolean indicating the success of this operation.
  - addPersistence
```
public boolean addPersistence(java.lang.String name,
                              PersistenceDef persistence)
```
    Description copied from interface: AdminService
    
    Adds the persistence definition for the given instance name
    
    Specified by:
    
    addPersistence in interface AdminService
    
    Parameters:
    
    name - The given name
    
    persistence - The persistence definition
    
    Returns:
    
    boolean indicating the success of this operation.
  - clonePersistence
```
public boolean clonePersistence(java.lang.String nameFrom,
                                java.lang.String nameTo)
```
    Description copied from interface: AdminService
    
    Clones the persistence definition from the source to the target.
    
    Specified by:
    
    clonePersistence in interface AdminService
    
    Parameters:
    
    nameFrom - The source name
    
    nameTo - The target name
    
    Returns:
    
    boolean indicating the success of this operation.
  - movePersistence
```
public boolean movePersistence(java.lang.String nameFrom,
                               java.lang.String nameTo)
```
    Description copied from interface: AdminService
    
    Moves the persistence definition from the source to the target.
    
    Specified by:
    
    movePersistence in interface AdminService
    
    Parameters:
    
    nameFrom - The source name
    
    nameTo - The target name
    
    Returns:
    
    boolean indicating the success of this operation.
  - deletePersistence
```
public boolean deletePersistence(java.lang.String name)
```
    Description copied from interface: AdminService
    
    Deletes the persistence definition of the given name.
    
    Specified by:
    
    deletePersistence in interface AdminService
    
    Parameters:
    
    name - The given name
    
    Returns:
    
    boolean indicating the success of this operation.
  - listDatabaseInstances
```
public java.lang.String[] listDatabaseInstances()
```
    Description copied from interface: AdminService
    
    Returns the list of database instances.
    
    Specified by:
    
    listDatabaseInstances in interface AdminService
    
    Returns:
    
    The string array of database instances.
  - getDatabase
```
public DatabaseDef getDatabase(java.lang.String name)
```
    Description copied from interface: AdminService
    
    Returns the database definition by the given database instance name.
    
    Specified by:
    
    getDatabase in interface AdminService
    
    Parameters:
    
    name - The given database instance name
    
    Returns:
    
    The database definition
  - setDatabase
```
public boolean setDatabase(DatabaseDef database)
```
    Description copied from interface: AdminService
    
    Sets the database definition.
    
    Specified by:
    
    setDatabase in interface AdminService
    
    Parameters:
    
    database - The database definition
    
    Returns:
    
    boolean indicating the success of this operation.
  - addDatabase
```
public boolean addDatabase(java.lang.String name,
                           DatabaseDef logging)
```
    Description copied from interface: AdminService
    
    Adds the database definition for the given instance name
    
    Specified by:
    
    addDatabase in interface AdminService
    
    Parameters:
    
    name - The given name
    
    logging - The database definition
    
    Returns:
    
    boolean indicating the success of this operation.
  - cloneDatabase
```
public boolean cloneDatabase(java.lang.String nameFrom,
                             java.lang.String nameTo)
```
    Description copied from interface: AdminService
    
    Clones the database definition from the source to the target.
    
    Specified by:
    
    cloneDatabase in interface AdminService
    
    Parameters:
    
    nameFrom - The source name
    
    nameTo - The target name
    
    Returns:
    
    boolean indicating the success of this operation.
  - moveDatabase
```
public boolean moveDatabase(java.lang.String nameFrom,
                            java.lang.String nameTo)
```
    Description copied from interface: AdminService
    
    Moves the database definition from the source to the target.
    
    Specified by:
    
    moveDatabase in interface AdminService
    
    Parameters:
    
    nameFrom - The source name
    
    nameTo - The target name
    
    Returns:
    
    boolean indicating the success of this operation.
  - deleteDatabase
```
public boolean deleteDatabase(java.lang.String name)
```
    Description copied from interface: AdminService
    
    Deletes the database definition of the given database name.
    
    Specified by:
    
    deleteDatabase in interface AdminService
    
    Parameters:
    
    name - The given database name
    
    Returns:
    
    boolean indicating the success of this operation.
  - listRuntimeNames
```
public java.lang.String[] listRuntimeNames()
```
    Description copied from interface: AdminService
    
    Returns the list of runtime names.
    
    Specified by:
    
    listRuntimeNames in interface AdminService
    
    Returns:
    
    The string array of runtime names.
  - listRuntimeServers
```
public java.lang.String[] listRuntimeServers()
```
    Description copied from interface: AdminService
    
    Returns the list of runtime servers.
    
    Specified by:
    
    listRuntimeServers in interface AdminService
    
    Returns:
    
    The string array of runtime servers.
  - listRuntimeAccounts
```
public java.lang.String[] listRuntimeAccounts()
```
    Description copied from interface: AdminService
    
    Returns the list of runtime accounts names.
    
    Specified by:
    
    listRuntimeAccounts in interface AdminService
    
    Returns:
    
    The string array of runtime accounts names.
  - searchRuntimeByAccount
```
public java.lang.String[] searchRuntimeByAccount(java.lang.String account,
                                                 java.lang.String itemName)
```
    Description copied from interface: AdminService
    
    Returns the list of target runtime names for the given account and the given item name.
    
    Specified by:
    
    searchRuntimeByAccount in interface AdminService
    
    Parameters:
    
    account - The given account
    
    itemName - The given item name
    
    Returns:
    
    The string array of target runtime names
  - getRuntime
```
public RuntimeDef getRuntime(java.lang.String serverName,
                             java.lang.String accountName)
```
    Description copied from interface: AdminService
    
    Returns the runtime definition for the given server and account names.
    
    Specified by:
    
    getRuntime in interface AdminService
    
    Parameters:
    
    serverName - The given server name
    
    accountName - The given account name
    
    Returns:
    
    The runtime definition
  - setRuntime
```
public boolean setRuntime(RuntimeDef runtime)
```
    Description copied from interface: AdminService
    
    Sets the runtime definition.
    
    Specified by:
    
    setRuntime in interface AdminService
    
    Parameters:
    
    runtime - The runtime definition
    
    Returns:
    
    boolean indicating the success of this operation.
  - addRuntime
```
public boolean addRuntime(java.lang.String serverName,
                          java.lang.String accountName,
                          RuntimeDef runtime)
```
    Description copied from interface: AdminService
    
    Adds the runtime definition for the given server and account names.
    
    Specified by:
    
    addRuntime in interface AdminService
    
    Parameters:
    
    serverName - The given server name
    
    accountName - The given account name
    
    runtime - The runtime definition
    
    Returns:
    
    boolean indicating the success of this operation.
  - cloneRuntime
```
public boolean cloneRuntime(java.lang.String serverNameFrom,
                            java.lang.String accountNameFrom,
                            java.lang.String serverNameTo,
                            java.lang.String accountNameTo)
```
    Description copied from interface: AdminService
    
    Clones the runtime definition from the source to the target.
    
    Specified by:
    
    cloneRuntime in interface AdminService
    
    Parameters:
    
    serverNameFrom - The source server name
    
    accountNameFrom - The source account name
    
    serverNameTo - The target server name
    
    accountNameTo - The target account name
    
    Returns:
    
    boolean indicating the success of this operation.
  - moveRuntime
```
public boolean moveRuntime(java.lang.String serverNameFrom,
                           java.lang.String accountNameFrom,
                           java.lang.String serverNameTo,
                           java.lang.String accountNameTo)
```
    Description copied from interface: AdminService
    
    Moves the runtime definition from the source to the target.
    
    Specified by:
    
    moveRuntime in interface AdminService
    
    Parameters:
    
    serverNameFrom - The source server name
    
    accountNameFrom - The source account name
    
    serverNameTo - The target server name
    
    accountNameTo - The target account name
    
    Returns:
    
    boolean indicating the success of this operation.
  - deleteRuntime
```
public boolean deleteRuntime(java.lang.String serverName,
                             java.lang.String accountName)
```
    Description copied from interface: AdminService
    
    Deletes the runtime definition for the given server and account names.
    
    Specified by:
    
    deleteRuntime in interface AdminService
    
    Parameters:
    
    serverName - The given server name
    
    accountName - The given account name
    
    Returns:
    
    boolean indicating the success of this operation.
  - getCertificateHierarchy
```
public TaggedName[] getCertificateHierarchy(java.lang.String alias)
```
    Given a certificate alias, it will compute the certificate signing chain.
    
    Specified by:
    
    getCertificateHierarchy in interface AdminService
    
    Parameters:
    
    alias - The certificate from which to start chain building
    
    Returns:
    
    a list of (alias, DN) entries, where root certificate is on first position
  - validateCertificate
```
public int validateCertificate(CertDef cert)
```
    Validate the given certificate, by its PEM data.
    
    Specified by:
    
    validateCertificate in interface AdminService
    
    Parameters:
    
    cert - The PEM representation of the certificate
    
    Returns:
    
    a value representing certificate validity state.
  - getCertificateDNProperties
```
public java.util.Map<java.lang.String,java.lang.String> getCertificateDNProperties(CertDef cd,
                                                                                   boolean owner)
```
    Get a map of the owner or issuer Distinctive Name properties.
    
    Specified by:
    
    getCertificateDNProperties in interface AdminService
    
    Parameters:
    
    cd - The certificate definition from which the info will be extracted.
    
    owner - true if the owner property should be retrieved; false for the issuer property.
    
    Returns:
    
    A map with certificate properties or null if the certificate PEM data could not be loaded.
  - getCertificateDNProperty
```
public java.lang.String getCertificateDNProperty(CertDef cd,
                                                 java.lang.String prop,
                                                 boolean owner)
```
    Get the value of the specified property, from the Distinctive Name entry associated with the owner or issuer.
    
    Specified by:
    
    getCertificateDNProperty in interface AdminService
    
    Parameters:
    
    cd - The certificate definition from which the info will be extracted.
    
    owner - true if the owner property should be retrieved; false for the issuer property.
    
    prop - The property name
    
    Returns:
    
    The value for the specified property.
  - getCertificateProperties
```
public java.util.Map<java.lang.String,java.lang.Object> getCertificateProperties(CertDef cd)
```
    Loads the X509 certificate from the specified definition and returns a map with properties for:
    - CertificateUtils.CERT_OWNER - this property will keep a Map of Distinctive Name properties for the owner
    - CertificateUtils.CERT_ISSUER - this property will keep a Map of Distinctive Name properties for the issuer
    - CertificateUtils.CERT_VALIDITY_NOT_BEFORE - the date from which this certificate starts to be valid.
    - CertificateUtils.CERT_VALIDITY_NOT_AFTER - the date from which this certificate's validity period ends.
    Specified by:
    
    getCertificateProperties in interface AdminService
    
    Parameters:
    
    cd - The certificate definition from which the info will be extracted.
    
    Returns:
    
    A map with certificate properties or null if the certificate PEM data could not be loaded.
  - isSelfSigned
```
public java.lang.Boolean isSelfSigned(CertDef cert)
```
    Check if the given certificate is self-signed.
    
    Specified by:
    
    isSelfSigned in interface AdminService
    
    Parameters:
    
    cert - The certificate which should be checked.
    
    Returns:
    
    true if this certificate is self-signed
  - getPreviewImages
```
public ReportPreview getPreviewImages(ReportRequest reportRequest,
                                      com.google.gwt.view.client.Range range)
                               throws java.io.IOException
```
    Gets report preview.
    
    Specified by:
    
    getPreviewImages in interface AdminService
    
    Parameters:
    
    reportRequest - Holds all required data to build the target report
    
    range - The preview range
    
    Returns:
    
    The report preview object that holds the requested page range and the number of all available pages for this preview.
    
    Throws:
    
    java.io.IOException - The IO exception if there is a failed IO operation
  - getVersionInfo
```
public java.lang.String getVersionInfo()
```
    Returns the current application version.
    
    Specified by:
    
    getVersionInfo in interface AdminService
    
    Returns:
    
    String presentation of the current application version number.
  - forceFloatSerialization
```
public java.lang.Float forceFloatSerialization()
```
    This method forces GWT to include Float into the list of serializable types. Since GWT doesn't provide a mechanism to include serializable types, this method was introduced as a workaround. Float serialization was introduced by AdminServerImpl.getReportParametersMap().
    
    Specified by:
    
    forceFloatSerialization in interface AdminService
    
    Returns:
    
    a float value.
  - updateHashedPassword
```
private static UserDef updateHashedPassword(UserDef userDef)
```
    Update the hashed password if the value of the plain password is given and then the plain password is cleared.
    
    Parameters:
    
    userDef - User account definition
    
    Returns:
    
    The same user definition object with new value for the "hashedPassword" field.
  - getReportParametersMap
```
public java.util.Map<java.lang.String,java.lang.Object> getReportParametersMap()
```
    Returns the map of report parameters to their values saved in the directory.
    
    Specified by:
    
    getReportParametersMap in interface AdminService
    
    Returns:
    
    The report parameters map
  - listTenants
```
public java.util.List<TenantManager.Tenant> listTenants()
```
    Get a list with all the tenants.
    
    Returns:
    
    A list with the registered tenants.
  - addTenant
```
public java.lang.Boolean addTenant(java.lang.String tenantName,
                                   java.util.List<TenantDatabaseDescriptor> databases)
```
    Add a tenant to the list.
    
    Parameters:
    
    tenantName - The name of the tenant.
    
    databases - A list of the databases that will be used by the tenant.
    
    Returns:
    
    true if the operation is performed successfully, false if the operation is not performed successfully, null if the caller does not have sufficient rights.
  - addDatabaseToTenant
```
public java.lang.Boolean addDatabaseToTenant(java.lang.String tenantName,
                                             TenantDatabaseDescriptor db)
```
    Function for adding a database instance to a tenant.
    
    Parameters:
    
    tenantName - The tenant for which to add the database instance.
    
    db - The database information to be added.
    
    Returns:
    
    true if the operation is performed successfully, false if the operation is not performed successfully, null if the caller does not have sufficient rights.
  - updateTenant
```
public java.lang.Boolean updateTenant(java.lang.String tenantName,
                                      java.lang.String pdbName,
                                      java.util.Map<java.lang.String,java.lang.String> values)
```
    Update a tenant from the master table. This method allows one or multiple column values to be edited. Possible column values/names are:
    - tenant_name - the name of the tenant.
    - db_name - the physical name of a database instance that this tenant uses.
    - url - the URL of a database instance.
    - username - the username required in order to access a database instance.
    - password - the password required in order to access a database instance.
    Parameters:
    
    tenantName - The name of the tenant that is targeted by the update.
    
    pdbName - The physical name of the database that is targeted by the update.
    
    values - A Map with pairs (column name - new value) that are intended for the update.
    
    Returns:
    
    true if all the updates are performed successfully, false if there is at least an update that fails, null if the caller does not have sufficient rights.
  - deleteTenant
```
public java.lang.Boolean deleteTenant(java.lang.String tenantName)
```
    Function for deleting a tenant from the master table.
    
    Parameters:
    
    tenantName - The name of the tenant that is targeted by the delete.
    
    Returns:
    
    true if the operation was successful, false otherwise. null if the caller does not have sufficient rights.
  - deleteDatabaseFromTenant
```
public java.lang.Boolean deleteDatabaseFromTenant(java.lang.String tenantName,
                                                  java.lang.String pdbName)
```
    Delete a database instance that is assigned to a tenant.
    
    Parameters:
    
    tenantName - The tenant for which to remove the database instance.
    
    pdbName - The physical database name for the database to be deleted.
    
    Returns:
    
    true if the operation was successful, false otherwise. null if the caller does not have sufficient rights.
  - changeTenantStatus
```
public java.lang.Boolean changeTenantStatus(java.lang.String tenantName,
                                            boolean enable)
```
    Enable/Disable a specific tenant.
    
    Parameters:
    
    tenantName - The tenant to work with.
    
    enable - true if the intent is to enable the tenant, false otherwise.
    
    Returns:
    
    true if the operation is performed successfully, false if the operation is not performed successfully, null if the caller does not have sufficient rights.
  - isTenantEnabled
```
public java.lang.Boolean isTenantEnabled(java.lang.String tenantName)
```
    Check if a specific tenant is enabled or not.
    
    Parameters:
    
    tenantName - The tenant to work with.
    
    Returns:
    
    true if the tenant is enabled, false otherwise. null if the caller does not have sufficient rights.

Class AdminServiceImpl

Nested Class Summary

Nested classes/interfaces inherited from interface com.goldencode.p2j.admin.shared.AdminService

Field Summary

Fields inherited from class com.google.gwt.user.server.rpc.AbstractRemoteServiceServlet

Constructor Summary

Method Summary

Methods inherited from class com.google.gwt.user.server.rpc.RemoteServiceServlet

Methods inherited from class com.google.gwt.user.server.rpc.AbstractRemoteServiceServlet

Methods inherited from class javax.servlet.http.HttpServlet

Methods inherited from class javax.servlet.GenericServlet

Methods inherited from class java.lang.Object

Constructor Detail

AdminServiceImpl

Method Detail

getServerName

isMaster

setTargetLive

setTargetFile

targetRefresh

isRefreshPending

canRefresh

getMessages

peekMessage

clearMessages

getAdminDef

getProfile

getProfile

backupDirectory

lockForRereadDir

rereadDirectory

cancelRereadDir

getSessionList

terminateSession

getRecordLockList

getDatabases

getDatabaseTables

lockRecords

getLockRecords

unlockRecords

shutdown

listResourceNames

getResourceType

changeResourceNames

getAuthConfig

setAuthConfig

fromDTO

toDTO

listHolidays

changeHolidays

getAudit

setAudit

listGroups

checkGroup

getGroup

setGroup

addGroup

deleteGroup

cloneGroup

listGroupUsers

changeGroupUsers

listUsers

checkUser

getUser

setUser

setUser

addUser

deleteUser

cloneUser

getOsUser

deleteOsUser

addOsUser

setOsUser

listAssociatedFwdUsers

cloneUser

listUserGroups

listOsUsers

checkOsUser

listProcesses

checkProcess