@RemoteServiceRelativePath(value="AdminService")
public interface AdminService
extends com.google.gwt.user.client.rpc.RemoteService
Modifier and Type | Interface and Description |
---|---|
static class |
AdminService.App
Utility/Convenience class.
|
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 database)
Adds the database definition for the given instance name
|
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 |
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 startup)
Adds the startup definition for the given instance name
|
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.
|
TaggedName |
checkGroup(java.lang.String name)
Check the group 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.
|
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 |
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.
|
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() |
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.
|
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 |
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[] |
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[] |
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.
|
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 |
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.
|
boolean |
unlockRecords()
Unlock the records which has been previously locked in the given context
using
lockRecords(com.goldencode.p2j.admin.RecordInfo[]) . |
int |
validateCertificate(CertDef cert)
Validate the given certificate, by its PEM data.
|
java.lang.String getServerName()
boolean isMaster()
true
if it canint setTargetLive(boolean stayCurrent)
stayCurrent
- if true
, all operations affect the most current
generation of the security cache, otherwise they affect
the generation attached to the admin sessionboolean setTargetFile(java.lang.String name, boolean create)
name
- name of a directory file to use as the targetcreate
- true
means a new directory file should be created,
otherwise the named directory file should exist.true
if the new target was set successfullyint targetRefresh()
boolean isRefreshPending()
true
if refresh is pending and false
is there is no pending refresh or current user has not enough
rights to perform it.boolean canRefresh()
true
user has enough rights to perform refresh.java.lang.String[][] getMessages(boolean all)
all
- if true
, then old and new messages are retrieved,
otherwise new messages onlyjava.lang.String peekMessage()
null
if nothing is generatedvoid clearMessages()
AdminDef getAdminDef()
AdminProfile[] getProfile(java.lang.String[] name)
name
- array of admin non-leaf resource instance names to querynull
AdminProfile[] getProfile(java.lang.String name, int[] perm)
name
- admin leaf resource instance name to queryperm
- array of permissions to querynull
boolean backupDirectory(java.lang.String newfile)
newfile
- name of a backup file to createtrue
if backup was successful.boolean lockForRereadDir(int seconds)
seconds
- Seconds to wait before lock will expire.true
if lock was successful.int rereadDirectory()
AdminConstants.ERR_NO_LOCK
- is returned when no lock is presentAdminConstants.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 etcvoid cancelRereadDir()
SessionInfo[] getSessionList()
null
if insufficient rights exist to obtain the
list.void terminateSession(int sid)
sid
- Session identifier.RecordLockInfo[] getRecordLockList()
null
if insufficient rights exist to obtain the
list.java.lang.String[] getDatabases()
java.lang.String[] getDatabaseTables(java.lang.String database)
database
- Target database.boolean lockRecords(RecordInfo[] records)
You can unlock records using unlockRecords()
.
records
- Records to lock.true
if records were successfully locked.boolean unlockRecords()
lockRecords(com.goldencode.p2j.admin.RecordInfo[])
.true
if records were successfully unlocked.RecordInfo[] getLockRecords()
lockRecords(com.goldencode.p2j.admin.RecordInfo[])
.boolean shutdown()
true
if successfuljava.lang.String[] listResourceNames()
java.lang.String getResourceType(java.lang.String name)
name
- plugin namenull
if no matchboolean changeResourceNames(java.lang.String[] additions, java.lang.String[] deletions)
additions
- array of resource names to add or null
if no additions are specifieddeletions
- array of resource names to delete or null
if no deletions are specifiedAuthConfigDef getAuthConfig()
boolean setAuthConfig(AuthConfigDef authConfig)
authConfig
- an instance loaded with the required configurationjava.util.Date[] listHolidays()
boolean changeHolidays(java.util.Date[] additions, java.util.Date[] deletions)
additions
- array of dates to add or null
if no additions are specifieddeletions
- array of dates to delete or null
if no deletions are specifiedAuditDef getAudit()
boolean setAudit(AuditDef audit)
audit
- The auditTaggedName[] listGroups()
null
TaggedName checkGroup(java.lang.String name)
name
- group namenull
if the named group does not existGroupDef getGroup(java.lang.String name)
name
- group namenull
if no such groupboolean setGroup(GroupDef group)
group
- group definitiontrue
if successfully changed the groupboolean addGroup(GroupDef group)
group
- group definition for a new accounttrue
if successfully added the groupboolean deleteGroup(java.lang.String name)
name
- group name for the group being deletedtrue
if successfully deleted the groupboolean cloneGroup(java.lang.String nameFrom, java.lang.String nameTo, boolean acls)
nameFrom
- group name for the source groupnameTo
- group name for the cloneacls
- true
tells to clone ACLs as welltrue
if successfully cloned the groupTaggedName[] listGroupUsers(java.lang.String name)
name
- group namenull
if there is no such groupboolean changeGroupUsers(java.lang.String name, java.lang.String[] additions, java.lang.String[] deletions)
name
- group nameadditions
- array of user names to be added to the group; may be emptydeletions
- array of user names to be excluded from the group;
may be emptytrue
if successfully changed the groupTaggedName[] listUsers()
null
TaggedName checkUser(java.lang.String name)
name
- user account namenull
if the named account does not existUserDef getUser(java.lang.String name)
name
- user account namenull
if no such userboolean setUser(UserDef user)
user
- user account definitiontrue
if successfully changed the accountboolean setUser(UserDef user, java.io.Serializable ext)
user
- user account definitionext
- optional extension container for custom account extensionstrue
if successfully changed the accountboolean addUser(UserDef user, java.io.Serializable ext)
user
- user account definitionext
- optional extension container for custom account extensionstrue
if successfully added the accountboolean deleteUser(java.lang.String name)
name
- user account name being deletedtrue
if successfully deleted the accountboolean cloneUser(java.lang.String nameFrom, java.lang.String nameTo, boolean acls)
nameFrom
- user account name for the sourcenameTo
- user account name for the cloneacls
- true
tells to clone ACLs as welltrue
if successfully cloned the user accountboolean cloneUser(java.lang.String nameFrom, java.lang.String nameTo, boolean acls, java.lang.String newPassword)
nameFrom
- user account name for the sourcenameTo
- user account name for the cloneacls
- true
tells to clone ACLs as wellnewPassword
- a replacement password for the clonetrue
if successfully cloned the user accountTaggedName[] listUserGroups(java.lang.String name)
name
- user account namenull
if there is no such user etcTaggedName[] listProcesses()
null
TaggedName checkProcess(java.lang.String name)
name
- process account namenull
if the named account does not existProcessDef getProcess(java.lang.String name)
name
- process namenull
if no such processboolean setProcess(ProcessDef process)
process
- process definitiontrue
if successfully changed the processboolean setProcess(ProcessDef process, java.io.Serializable ext)
process
- process definitionext
- optional extension container for custom account extensionstrue
if successfully changed the processboolean addProcess(ProcessDef process, java.io.Serializable ext)
process
- process definition for a new accountext
- optional extension container for custom account extensionstrue
if successfully added the processboolean deleteProcess(java.lang.String name)
name
- process account name being deletedtrue
if successfully deleted the processboolean cloneProcess(java.lang.String nameFrom, java.lang.String nameTo, boolean acls)
nameFrom
- process name for the sourcenameTo
- process name for the cloneacls
- true
tells to clone ACLs as welltrue
if successfully cloned the processTaggedName[] listAuthCerts(boolean unusedOnly)
unusedOnly
- if true
, lists unused certificates only, otherwise
all certificatesnull
TaggedName[] listPeerCerts(boolean unusedOnly)
unusedOnly
- if true
, lists unused certificates only, otherwise
all certificatesnull
TaggedName[] getCertUsers(java.lang.String alias)
alias
- certificate alias namenull
TaggedName[] getCertProcesses(java.lang.String alias)
alias
- certificate alias namenull
TaggedName[] getCertAccounts(java.lang.String alias)
alias
- certificate alias namenull
CertDef getCert(java.lang.String alias)
alias
- the alias of the certificate to getnull
boolean setCert(CertDef cert)
cert
- encoded certificatetrue
if replaced, false
if errorsboolean addCert(CertDef cert)
cert
- encoded certificatetrue
if added, false
if errorsboolean moveCert(java.lang.String aliasFrom, java.lang.String aliasTo)
aliasFrom
- current certificate's aliasaliasTo
- new certificate's aliastrue
if changed, false
if errorsjava.lang.String searchCert(java.lang.String dn)
dn
- distinctive namenull
.boolean deleteCert(java.lang.String alias, boolean force)
alias
- the alias of the certificate being deletedforce
- if true
, the certificate is deleted even if
in usetrue
if deleted, false
if errorsjava.lang.String[] listAclInstances()
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.
java.lang.String[] listAclInstances(java.lang.String resourceType)
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.
resourceType
- name of the resource of interestjava.lang.String[] listInstanceAcls(java.lang.String instanceName)
instanceName
- name of the ACL instance; empty string for the shared oneAclDef getAcl(java.lang.String resourceType, java.lang.String instanceName)
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
null
AclDef[] getAllAcls(java.lang.String instanceName)
instanceName
- name of the ACL instance; empty string for the shared one;
if null
, all ACLs are returned and some may be
combinednull
AclDef getEffectiveAcls(java.lang.String resourceType)
resourceType
- name of the resource of interest; can't be null
null
boolean addAcl(java.lang.String resourceType, Acl acl, java.util.Map<java.lang.Integer,java.lang.String> subjMap)
resourceType
- name of the resource to add the ACL foracl
- ACL definition, that should come fully defined, including the
instance name.subjMap
- a map to translate numeric subject IDs back to namestrue
if added, false
if errorsboolean 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)
resourceType
- name of the resource to set the ACL foracl
- ACL definitionsubjMap
- a map to translate numeric subject IDs back to names;
needed only when setSubjects is true
and can be
null
all other timessetInstance
- true
if setting the resource instance namesetInstanceMode
- true
if setting the resource instance name modesetSubjects
- true
if setting the subjects IDssetRights
- true
if setting the rights for this ACLtrue
if set, false
if errorsboolean moveAcl(java.lang.String resourceType, java.lang.String instanceName, int oid, java.lang.String newInstanceName)
resourceType
- name of the resource of interestinstanceName
- name of the source ACL instance; empty string for the shared oneoid
- ACL object ID that selects the ACL to movenewInstanceName
- name of the target ACL instance; empty string for the shared onetrue
if moved, false
if errorsboolean moveAcl(java.lang.String resourceType, java.lang.String instanceName, int oid, int newOid)
resourceType
- name of the resource of interestinstanceName
- name of the source ACL instance; empty string for the shared oneoid
- ACL object ID that selects the ACL to movenewOid
- new ACL object IDtrue
if moved, false
if errorsboolean deleteAcl(java.lang.String resourceType, java.lang.String instanceName, int oid)
resourceType
- name of the resource of interestinstanceName
- name of the source ACL instance; empty string for the shared oneoid
- ACL object ID that selects the ACL to deletetrue
if deleted, false
if errorsboolean cloneAcl(java.lang.String resourceType, java.lang.String instanceName, int oid, int cloneOid)
resourceType
- name of the resource of interestinstanceName
- name of the source ACL instance; empty string for the shared oneoid
- ACL object ID that selects the ACL to clonecloneOid
- ACL object ID for the clonetrue
if cloned, false
if errorsboolean resequenceAcls(java.lang.String resourceType, java.lang.String instanceName, int start, int step)
resourceType
- name of the resource of interestinstanceName
- name of the source ACL instance; empty string for the shared onestart
- the starting numberstep
- the incrementtrue
if success, false
if errorsboolean addAclInstance(java.lang.String instanceName)
instanceName
- name of the ACL instance; empty string for the shared onetrue
if created, false
if errorsboolean deleteAclInstance(java.lang.String instanceName)
instanceName
- name of the ACL instance; empty string for the shared onetrue
if deleted, false
if errorsboolean deleteAclInstance(java.lang.String resourceType, java.lang.String instanceName)
resourceType
- name of the resource of interestinstanceName
- name of the ACL instance; empty string for the shared onetrue
if deleted, false
if errorsboolean cloneAclInstance(java.lang.String instanceFrom, java.lang.String instanceTo)
instanceFrom
- name of the source ACL instance; empty string for the shared oneinstanceTo
- name of the target ACL instance; empty string for the shared onetrue
if cloned, false
if errorsboolean cloneAclInstance(java.lang.String resourceType, java.lang.String instanceFrom, java.lang.String instanceTo)
resourceType
- name of the resource of interestinstanceFrom
- name of the source ACL instance; empty string for the shared oneinstanceTo
- name of the target ACL instance; empty string for the shared onetrue
if cloned, false
if errorsboolean moveAclInstance(java.lang.String instanceFrom, java.lang.String instanceTo)
instanceFrom
- name of the source ACL instance; empty string for the shared oneinstanceTo
- name of the target ACL instance; empty string for the shared onetrue
if moved, false
if errorsboolean moveAclInstance(java.lang.String resourceType, java.lang.String instanceFrom, java.lang.String instanceTo)
resourceType
- name of the resource of interestinstanceFrom
- name of the source ACL instance; empty string for the shared oneinstanceTo
- name of the target ACL instance; empty string for the shared onetrue
if moved, false
if errorsjava.lang.String[] listServers()
java.lang.String[] listServers(java.lang.String containers)
containers
- one or more container names separated by "/"TaggedName[] listAuthPlugins()
null
if no plugins are available.int bulkAuthModeUpdate(int targetAccounts, java.lang.String[] excludedAccounts, int authMode, java.lang.String authPlugin)
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.-1
if an error
has occured.TaggedName[] getRegisteredJars()
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.java.lang.String[] getUnregisteredJars()
java.lang.String[] getAvailableJarHookClasses(java.lang.String jar)
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.jar
- The name of the target jar file.InitTermListener
interface.java.lang.String getStoredJarHookClass(java.lang.String jar)
jar
- The name of the target jar file (should be loaded).null
if the jar has
no hook specified.JarOpErrorCode registerJar(java.lang.String jar, java.lang.String hookClass, boolean storeInDirectory)
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.JarOpErrorCode deregisterJar(java.lang.String jar, boolean force, boolean removeFromDirectory)
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.JarOpErrorCode deregisterJarFromDirectory(java.lang.String jar, java.lang.String storedHookClass)
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.JarOpErrorCode changeJarHookClass(java.lang.String jar, java.lang.String hookClass)
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.TaggedName[] getRegisteredJarAPIs(java.lang.String jar)
jar
- The name of the target jar file.java.lang.String[] getAvailableJarAPIInterfaces(java.lang.String jar, boolean showRegistered)
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).java.lang.String[] getAvailableJarAPIImplClasses(java.lang.String jar, java.lang.String interfaceClass)
jar
- The name of the target jar file.interfaceClass
- Fully qualified name of the target interface.JarOpErrorCode registerJarAPI(java.lang.String interfaceClass, java.lang.String implementationClass)
interfaceClass
- Fully qualified name of the interface which defines the target
API.implementationClass
- Fully qualified name of the class which implements the target
API.JarOpErrorCode deregisterJarAPI(java.lang.String jar, java.lang.String interfaceClass, boolean force)
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
.JarOpErrorCode changeJarHooksType(boolean serverWide, boolean move)
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.SessionInfo[] getActiveSessions(java.lang.String jar, java.lang.String apiInterfaceClass)
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.java.lang.Boolean isUsingServerWideHooks()
true
if server-wide hooks are used,
false
if global hooks are used, null
if you have insufficient access rights.java.lang.Boolean isUsingMultiClassLoader()
MultiClassLoader
is used as the
system class loader.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 permissionsTaggedName getManagedLibsDirInformation()
"true"
if this directory exists and is accessible.
If you do not have admin rights, null
is returned.java.lang.String[] listLoggingInstances()
LoggingDef getLogging(java.lang.String name)
name
- The given nameboolean setLogging(LoggingDef logging)
logging
- The logging definitionboolean addLogging(java.lang.String name, LoggingDef logging)
name
- The given namelogging
- The logging definitionboolean cloneLogging(java.lang.String nameFrom, java.lang.String nameTo)
nameFrom
- The source namenameTo
- The target nameboolean moveLogging(java.lang.String nameFrom, java.lang.String nameTo)
nameFrom
- The source namenameTo
- The target nameboolean deleteLogging(java.lang.String name)
name
- The given namejava.lang.String[] listExportsInstances()
ExportsDef getExports(java.lang.String name)
name
- The given export instance nameboolean setExports(ExportsDef logging)
logging
- The export definitionboolean addExports(java.lang.String name, ExportsDef logging)
name
- The given namelogging
- The export definitionboolean cloneExports(java.lang.String nameFrom, java.lang.String nameTo)
nameFrom
- The source namenameTo
- The target nameboolean moveExports(java.lang.String nameFrom, java.lang.String nameTo)
nameFrom
- The source namenameTo
- The target nameboolean deleteExports(java.lang.String name)
name
- The given namejava.lang.String[] listStartupInstances()
StartupDef getStartup(java.lang.String name)
name
- The given startup instance nameboolean setStartup(StartupDef startup)
startup
- The startup definitionboolean addStartup(java.lang.String name, StartupDef startup)
name
- The given namestartup
- The startup definitionboolean cloneStartup(java.lang.String nameFrom, java.lang.String nameTo)
nameFrom
- The source namenameTo
- The target nameboolean moveStartup(java.lang.String nameFrom, java.lang.String nameTo)
nameFrom
- The source namenameTo
- The target nameboolean deleteStartup(java.lang.String name)
name
- The given namejava.lang.String[] listPersistenceInstances()
PersistenceDef getPersistence(java.lang.String name)
name
- The given persistence instance nameboolean setPersistence(PersistenceDef persistence)
persistence
- The persistence definitionboolean addPersistence(java.lang.String name, PersistenceDef persistence)
name
- The given namepersistence
- The persistence definitionboolean clonePersistence(java.lang.String nameFrom, java.lang.String nameTo)
nameFrom
- The source namenameTo
- The target nameboolean movePersistence(java.lang.String nameFrom, java.lang.String nameTo)
nameFrom
- The source namenameTo
- The target nameboolean deletePersistence(java.lang.String name)
name
- The given namejava.lang.String[] listDatabaseInstances()
DatabaseDef getDatabase(java.lang.String name)
name
- The given database instance nameboolean setDatabase(DatabaseDef database)
database
- The database definitionboolean addDatabase(java.lang.String name, DatabaseDef database)
name
- The given namedatabase
- The database definitionboolean cloneDatabase(java.lang.String nameFrom, java.lang.String nameTo)
nameFrom
- The source namenameTo
- The target nameboolean moveDatabase(java.lang.String nameFrom, java.lang.String nameTo)
nameFrom
- The source namenameTo
- The target nameboolean deleteDatabase(java.lang.String name)
name
- The given database namejava.lang.String[] listRuntimeNames()
java.lang.String[] listRuntimeServers()
java.lang.String[] listRuntimeAccounts()
java.lang.String[] searchRuntimeByAccount(java.lang.String account, java.lang.String itemName)
account
- The given accountitemName
- The given item nameRuntimeDef getRuntime(java.lang.String serverName, java.lang.String accountName)
serverName
- The given server nameaccountName
- The given account nameboolean setRuntime(RuntimeDef runtime)
runtime
- The runtime definitionboolean addRuntime(java.lang.String serverName, java.lang.String accountName, RuntimeDef runtime)
serverName
- The given server nameaccountName
- The given account nameruntime
- The runtime definitionboolean cloneRuntime(java.lang.String serverNameFrom, java.lang.String accountNameFrom, java.lang.String serverNameTo, java.lang.String accountNameTo)
serverNameFrom
- The source server nameaccountNameFrom
- The source account nameserverNameTo
- The target server nameaccountNameTo
- The target account nameboolean moveRuntime(java.lang.String serverNameFrom, java.lang.String accountNameFrom, java.lang.String serverNameTo, java.lang.String accountNameTo)
serverNameFrom
- The source server nameaccountNameFrom
- The source account nameserverNameTo
- The target server nameaccountNameTo
- The target account nameboolean deleteRuntime(java.lang.String serverName, java.lang.String accountName)
serverName
- The given server nameaccountName
- The given account nameTaggedName[] getCertificateHierarchy(java.lang.String alias)
alias
- The certificate from which to start chain buildingint validateCertificate(CertDef cert)
cert
- The PEM representation of the certificatejava.util.Map<java.lang.String,java.lang.String> getCertificateDNProperties(CertDef cd, boolean owner)
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.null
if the certificate PEM data
could not be loaded.java.lang.String getCertificateDNProperty(CertDef cd, java.lang.String prop, boolean owner)
cd
- The certificate definition from which the info will be extracted.prop
- The property nameowner
- true
if the owner property should be retrieved;
false
for the issuer property.java.util.Map<java.lang.String,java.lang.Object> getCertificateProperties(CertDef cd)
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.
cd
- The certificate definition from which the info will be extracted.null
if the certificate PEM data
could not be loaded.java.lang.Boolean isSelfSigned(CertDef cert)
cert
- The certificate which should be checked.true
if this certificate is self-signedReportPreview getPreviewImages(ReportRequest reportRequest, com.google.gwt.view.client.Range range) throws java.io.IOException
reportRequest
- Holds all required data to build the target reportrange
- The preview rangejava.io.IOException
- The IO exception if there is a failed IO operationjava.util.Map<java.lang.String,java.lang.Object> getReportParametersMap()
java.lang.String getVersionInfo()
java.lang.Float forceFloatSerialization()