public interface ResourceManager
Modifier and Type | Method and Description |
---|---|
java.lang.String |
addFolder(java.lang.String userID,
java.lang.String parentPath,
java.util.Hashtable htFolder)
Deprecated.
since version 6.1, replaced by createFolder(...) and addResourcesToFolder(...).
the param "includesSubDir" of the method addResourcesToFolder(...) should be true in this case.
|
VersionRecord |
addResource(java.lang.String userID,
java.lang.String folderPath,
boolean isAutoConvert,
java.util.Hashtable htResource,
java.util.Hashtable[] permissions)
Adds a resource into a specific folder.
|
VersionRecord |
addResource(java.lang.String userID,
java.lang.String folderPath,
java.util.Hashtable htResource)
Deprecated.
since version 6.1, replaced by addResource(String userID, String folderPath, Hashtable htResource, Hashtable[] permissions)
|
VersionRecord |
addResource(java.lang.String userID,
java.lang.String folderPath,
java.util.Hashtable htResource,
java.util.Hashtable[] permissions)
Adds a resource into a specific folder
|
java.lang.String |
addResourcesToFolder(java.lang.String userID,
java.lang.String folderPath,
java.lang.String fromRealDir,
boolean includesSubDir,
boolean isAutoConvert,
java.util.Hashtable htResource,
java.util.Hashtable[] permissions)
Adds files and sub-folders into a specific folder.
|
void |
addResourcesToFolder(java.lang.String userID,
java.lang.String folderPath,
java.lang.String fromRealDir,
boolean includesSubDir,
java.util.Hashtable htResource,
java.util.Hashtable[] permissions)
Adds files and sub-folders into a specific folder.
|
VersionRecord |
addResultInReport(java.lang.String userID,
java.lang.String reportPath,
java.util.Hashtable htResult)
Adds a result into a specific report.
|
boolean |
checkPermission(java.lang.String userID,
java.lang.String resourcePath,
int versionNumber,
java.security.acl.Permission permission)
Checks whether the specific user has a permission on a specific version number of a resource path.
|
boolean |
checkPermission(java.lang.String userID,
java.lang.String resourcePath,
java.security.acl.Permission permission)
Checks whether a specific user has a permission on a specific resource path.
|
java.lang.String |
createFolder(java.lang.String userID,
java.lang.String parentPath,
java.lang.String folderName,
java.util.Hashtable htFolder,
java.util.Hashtable[] permissions)
Adds a sub-folder into a specific folder.
|
java.util.Vector |
getAllRoles(java.lang.String submitter)
Gets all roles.
|
java.util.Vector |
getAllUsers(java.lang.String submitter)
Gets all users.
|
java.util.Vector<PathInfo> |
getCatalogsInPath(java.lang.String userID,
java.lang.String path)
Gets the catalogs in a resource path.
|
CatalogVersionRecord |
getCatalogVersion(java.lang.String userID,
java.lang.String path,
int versionNumber)
Gets a catalog version by catalog name and version number
|
java.util.Vector<CatalogVersionRecord> |
getCatalogVersions(java.lang.String userID,
java.lang.String catName)
Gets the versions of a specific catalog.
|
java.util.Vector<PathInfo> |
getDashboardsInPath(java.lang.String userID,
java.lang.String path)
Gets the dashboards in a resource path.
|
java.util.Vector |
getEnabledCustomFieldNames()
Gets all names of enabled custom fields.
|
java.lang.String[] |
getExtensions(java.lang.String mimeType)
Gets file extensions of the MIME type.
|
java.util.Vector |
getFileSysDirsInPath(java.lang.String userID,
java.lang.String path)
Deprecated.
As of version 6, replaced by getFoldersInPath().
|
java.util.Vector |
getFileSysFilesInPath(java.lang.String userID,
java.lang.String path)
Deprecated.
As of version 6, it was obsolete.
|
java.util.Vector<PathInfo> |
getFoldersInPath(java.lang.String userID,
java.lang.String path)
Gets the folders in a resource path.
|
java.lang.String |
getHistDir()
Gets the directory which result versions are saved to.
|
java.lang.String |
getHistFile(java.lang.String file)
Gets the history file directory path.
|
java.util.Vector |
getImagesByCatalog(java.lang.String userID,
java.lang.String path)
Gets the image files in the resource path.
|
java.lang.String |
getInheritedLinkedCatalog(java.lang.String userID,
java.lang.String path)
Gets inherited linked catalog.
|
java.util.Hashtable[] |
getInheritedPermissions(java.lang.String userID,
java.lang.String path,
int versionNumber)
Gets the inherited permissions of the users attached to the specific path.
|
int |
getLatestVersionNumber(java.lang.String resourcePath)
Gets the latest version number of a specific resource.
|
int |
getLatestVersionNumber(java.lang.String resourcePath,
java.lang.String userID)
Gets the latest version number of a specific resource.
|
java.util.Vector<PathInfo> |
getLCsInPath(java.lang.String userID,
java.lang.String path)
Gets the LCs in a resource path.
|
LCVersionRecord |
getLCVersion(java.lang.String userID,
java.lang.String path,
int versionNumber)
Gets an LC version by LC name and version number
|
java.util.Vector<LCVersionRecord> |
getLCVersions(java.lang.String userID,
java.lang.String lcName)
Gets the versions of a specific LC.
|
java.lang.String |
getMIMEType(java.lang.String extName)
Gets the MIME type of a file extension.
|
PathInfo |
getPathInfo(java.lang.String userID,
java.lang.String path)
Gets PathInfo for a specific user.
|
java.util.Hashtable[] |
getPermissions(java.lang.String userID,
java.lang.String path,
int versionNumber)
Gets the defined permissions of the users attached to the specific path.
|
java.lang.String |
getRealm()
Gets the active realm.
|
java.lang.String |
getRealmDir()
Gets the directory of the active realm.
|
java.lang.String |
getRealPathOfNode(java.lang.String userID,
java.lang.String path)
Gets the real path property of a node, which is specified by path.
|
java.util.Vector |
getReferGroups(java.lang.String userID)
Gets the groups which the specific user belongs to.
|
java.util.Vector |
getReferRoles(java.lang.String userID)
Gets the roles which the specific user belongs to.
|
java.util.Vector |
getReferUsers(java.lang.String userID)
Gets the users which belong to the same role as the specific user.
|
java.util.Vector |
getReports(java.lang.String userID,
java.lang.String catalog)
Deprecated.
As of version 6, replaced by getReportsInPath().
|
java.util.Vector<PathInfo> |
getReportsInPath(java.lang.String userID,
java.lang.String path)
Gets the reports in a resource path.
|
ReportVersionRecord |
getReportVersion(java.lang.String userID,
java.lang.String rptPath,
int versionNumber)
Gets a version of a specific report by version number.
|
java.util.Vector<ReportVersionRecord> |
getReportVersions(java.lang.String userID,
java.lang.String rptName)
Gets the versions of a specific report.
|
java.io.InputStream |
getResourceTreeInputStream(java.lang.String userID,
int streamType,
java.lang.String[] roots,
java.lang.String[] suffixes,
java.util.Locale locale)
Gets resource tree XML input stream.
|
java.io.InputStream |
getResourceTreeInputStream(java.lang.String userID,
java.lang.String... pathPrefix)
Gets resource tree XML input stream.
|
java.io.InputStream |
getResourceTreeInputStreamByType(java.lang.String userID,
int streamType,
java.lang.String... pathPrefix)
Gets resource tree XML input stream.
|
ResultVersionRecord |
getResultDocVersion(java.lang.String userID,
java.lang.String resultDocName,
int versionNumber)
Gets a version of a specific result doc by version number.
|
java.util.Vector<ResultVersionRecord> |
getResultDocVersions(java.lang.String userID,
java.lang.String resultDocName)
Gets the versions of a specific result.
|
int |
getResultMaxVersionAmount(java.lang.String userID,
java.lang.String reportResource)
Gets the maximum number of versions of a specific report's results.
|
java.util.Vector |
getResultsInPath(java.lang.String userID,
java.lang.String path)
Gets the results in a resource path.
|
ResultVersionRecord |
getResultVersion(java.lang.String userID,
java.lang.String rptName,
int versionNumber)
Gets a result version attached to a specific report by version number.
|
ResultVersionRecord |
getResultVersionByNodeID(java.lang.String recordID)
Gets a result version by node id
|
java.util.Vector<ResultVersionRecord> |
getResultVersions(java.lang.String userID,
java.lang.String rptName)
Gets the result versions attached to a specific report.
|
java.util.Vector |
getRolesByUser(java.lang.String submitter,
java.lang.String userID)
Gets the roles which the specific user has.
|
java.lang.String |
getRoot()
Gets the resource root directory of the report server.
|
java.lang.String |
getRootNodeDisplay(java.util.Locale locale)
Get "Root" node's display text on UI for specified locale.
|
java.lang.String |
getSchedulePath()
Gets the path of the Schedule.
|
SearchHelper |
getSearchHelper(int helperId)
Gets the SearchHelper object.
|
java.util.Vector<PathInfo> |
getSubnodes(java.lang.String userID,
java.lang.String path)
Gets the sub-nodes of a resource node in the resource tree.
|
java.util.Vector |
getSubpaths(java.lang.String userID,
java.lang.String path)
Deprecated.
As of version 6, replaced by getFoldersInPath().
|
java.util.Vector<PathInfo> |
getSubpathsAndCatalogs(java.lang.String userID,
java.lang.String path)
Gets the sub-paths of a resource path and catalogs.
|
java.lang.String |
getTempDir()
Gets the temporary directory of the server.
|
java.util.Vector |
getUsersByRole(java.lang.String submitter,
java.lang.String roleID)
Gets the users who have the specific role.
|
VersionRecord |
getVersion(java.lang.String userID,
java.lang.String resourcePath,
int versionNumber)
Gets a resource version by resource name and version number
|
boolean |
isAdminUser(java.lang.String userID)
Checks if a user is an administrator.
|
boolean |
isCatalogLinked(java.lang.String userID,
java.lang.String path)
Checks whether the catalog is linked.
|
boolean |
isNodeExist(java.lang.String path,
java.lang.String userName)
Checks whether or not the specified node exists.
|
boolean |
isOrganizationAdminUser(java.lang.String userID)
Checks if a user is an administrator of an organization.
|
void |
loadUserResAliasToMem(java.lang.String userID)
Loads resource alias of a user from database and saves them into memory.
|
java.lang.String |
refreshFolders(java.lang.String userID)
Deprecated.
reference
#getResourceTreeInputStream(String) |
void |
removeNode(java.lang.String userID,
java.lang.String path)
Removes the specific node which is indicated by path.
|
void |
removeVersion(java.lang.String userID,
java.lang.String versionID)
Removes a specific version.
|
void |
rmUserResAliasFromMem(java.lang.String userID)
Removes resource alias of a user from memory.
|
void |
setNodeProperties(java.lang.String userID,
java.lang.String path,
java.util.Hashtable htProps,
java.util.Hashtable[] permissions)
Sets the properties and permissions of the users for a specific path.
|
void |
setNodeProperties(java.lang.String userID,
java.lang.String path,
int versionNumber,
java.util.Hashtable htProps,
java.util.Hashtable[] permissions)
Sets the properties and permissions of the users for a specific version of path.
|
void |
setPermissions(java.lang.String userID,
java.lang.String path,
int versionNumber,
java.util.Hashtable[] permissions)
Sets the permissions of users for a specific path.
|
void |
setResultMaxVersionAmount(java.lang.String userID,
java.lang.String reportResource,
int maxVersionAmount)
Sets the maximum number of versions of a specific report's results.
|
void |
setResultVersionProperties(java.lang.String userID,
java.lang.String report,
int versionNumber,
java.util.Hashtable htProps)
Sets the properties of the users for a specific result version of report.
|
java.lang.String getMIMEType(java.lang.String extName)
extName
- the file extension.java.lang.String[] getExtensions(java.lang.String mimeType)
mimeType
- the MIME type.java.lang.String getRealm()
java.lang.String getRealmDir()
java.lang.String getTempDir()
java.lang.String getHistDir()
java.lang.String getRoot()
PathInfo getPathInfo(java.lang.String userID, java.lang.String path) throws RptServerException
userID
- the user ID.path
- the resource path, for example, /SunVMDemo.RptServerException
- if an RptServerException
occurs.PathInfo
java.util.Vector getSubpaths(java.lang.String userID, java.lang.String path) throws RptServerException
userID
- the user ID.path
- the resource path, for example, /SunVMDemo.Vector
contains PathInfo objects.RptServerException
- if an RptServerException
occurs.PathInfo
java.util.Vector<PathInfo> getSubpathsAndCatalogs(java.lang.String userID, java.lang.String path) throws RptServerException
userID
- the user ID.path
- the resource path, for example, /SunVMDemo.RptServerException
- if an RptServerException
occurs.PathInfo
java.util.Vector<PathInfo> getSubnodes(java.lang.String userID, java.lang.String path) throws RptServerException
userID
- the user ID.path
- the resource node, for example, /SunVMDemo.Vector
contains PathInfo
objects.RptServerException
- if an RptServerException
occurs.PathInfo
java.util.Vector<PathInfo> getCatalogsInPath(java.lang.String userID, java.lang.String path) throws RptServerException
userID
- the user ID.path
- the resource path, for example, /SunVMDemo.Vector
contains PathInfo
objects.RptServerException
- if an RptServerException
occurs.PathInfo
java.util.Vector<PathInfo> getLCsInPath(java.lang.String userID, java.lang.String path) throws RptServerException
userID
- the user ID.path
- the resource path, for example, /COMPONSNET_LIB/SunVMDemo.Vector
contains PathInfo
objects.RptServerException
- if an RptServerException
occurs.V10.1
java.util.Vector getFileSysDirsInPath(java.lang.String userID, java.lang.String path) throws RptServerException
userID
- the user ID.path
- the resource path, for example, /SunVMDemo.Vector
contains PathInfo
objects.RptServerException
- if an RptServerException
occurs.PathInfo
java.util.Vector getFileSysFilesInPath(java.lang.String userID, java.lang.String path) throws RptServerException
userID
- the user ID.path
- the resource path, for example, /SunVMDemo.Vector
contains PathInfo
objects.RptServerException
- if an RptServerException
occurs.PathInfo
java.util.Vector getReports(java.lang.String userID, java.lang.String catalog) throws RptServerException
userID
- the user ID.catalog
- the catalog, for example, /SunVMDemo/SunVMDemo.cat.Vector
contains PathInfo
objects.RptServerException
- if an RptServerException
occurs.PathInfo
java.lang.String getSchedulePath()
java.lang.String getHistFile(java.lang.String file)
file
- the file.java.util.Vector<PathInfo> getReportsInPath(java.lang.String userID, java.lang.String path) throws NoPrivilegeException, UnknownResource
userID
- the user ID.path
- the resource path, for example, /SunVMDemo.Vector
contains PathInfo
objects.NoPrivilegeException
- if a NoPrivilegeException occurs.UnknownResource
- if no node can be found by the path .PathInfo
java.util.Vector<PathInfo> getDashboardsInPath(java.lang.String userID, java.lang.String path) throws NoPrivilegeException, UnknownResource
userID
- the user ID.path
- the resource path, for example, /SunVMDemo.Vector
contains PathInfo
objects.NoPrivilegeException
- if a NoPrivilegeException occurs.UnknownResource
- if no node can be found by the path.PathInfo
java.util.Vector getImagesByCatalog(java.lang.String userID, java.lang.String path) throws NoPrivilegeException, UnknownResource
userID
- the user ID.catalog
- the full catalog path, for example, /SunVMDemo/SunVMDemo.cat.Vector
contains PathInfo
objects.NoPrivilegeException
- if a NoPrivilegeException occurs.UnknownResource
- if no node can be found by the path.PathInfo
java.util.Vector getResultsInPath(java.lang.String userID, java.lang.String path) throws NoPrivilegeException, UnknownResource
userID
- the user ID.path
- the resource path, for example, /SunVMDemo.Vector
contains PathInfo
objects.NoPrivilegeException
- if a NoPrivilegeException occurs.UnknownResource
- if no node can be found by the path .PathInfo
java.util.Vector<PathInfo> getFoldersInPath(java.lang.String userID, java.lang.String path) throws NoPrivilegeException, UnknownResource
userID
- the user ID.path
- the resource path, for example, /SunVMDemo.Vector
contains PathInfo
objects.NoPrivilegeException
- if a NoPrivilegeException occurs.UnknownResource
- if no node can be found by the path.PathInfo
java.util.Vector<CatalogVersionRecord> getCatalogVersions(java.lang.String userID, java.lang.String catName) throws NoPrivilegeException, UnknownResource
userID
- the user ID.catName
- the catalog name, for example, /SampleReports/Tutorail.cat.CatalogVersionRecord
objects.NoPrivilegeException
- if a NoPrivilegeException occurs.UnknownResource
- if no node can be found by the path.CatalogVersionRecord
java.util.Vector<LCVersionRecord> getLCVersions(java.lang.String userID, java.lang.String lcName) throws NoPrivilegeException, UnknownResource
userID
- the user ID,lcName
- the LC name, for example, /COMPONENT_LIB/Tutorail.lc.LCVersionRecord
objects.NoPrivilegeException
- if a NoPrivilegeException occurs.UnknownResource
- if no node can be found by the pathLCVersionRecord
java.util.Vector<ReportVersionRecord> getReportVersions(java.lang.String userID, java.lang.String rptName) throws NoPrivilegeException, UnknownResource
userID
- the user ID,rptName
- the report name, for example, /SampleReports/CustomerAnalysis.cls.ReportVersionRecord
objects.NoPrivilegeException
- if a NoPrivilegeException
occurs.UnknownResource
- if no node can be found by the pathReportVersionRecord
java.util.Vector<ResultVersionRecord> getResultVersions(java.lang.String userID, java.lang.String rptName) throws NoPrivilegeException, UnknownResource
userID
- the user ID,rptName
- the report name, for example, /SampleReports/CustomerAnalysis.cls.ResultVersionRecord
objects.NoPrivilegeException
- if a NoPrivilegeException occurs.UnknownResource
- if no node can be found by the pathResultVersionRecord
java.util.Vector<ResultVersionRecord> getResultDocVersions(java.lang.String userID, java.lang.String resultDocName) throws NoPrivilegeException, UnknownResource
userID
- the user ID,resultDocName
- the result name, for example, /SampleReports/resultdoc1.ResultVersionRecord
objects.NoPrivilegeException
- if a NoPrivilegeException occurs.UnknownResource
- if no node can be found by the pathResultVersionRecord
CatalogVersionRecord getCatalogVersion(java.lang.String userID, java.lang.String path, int versionNumber) throws NoPrivilegeException, UnknownResource
userID
- the user ID,path
- the catalog path, for example, /SampleReports/Tutorail.cat.versionNumber
- the version numberCatalogVersionRecord
object.
or null if it cannot get the specific versionNoPrivilegeException
- if a NoPrivilegeException occurs.UnknownResource
- if no node can be found by the pathCatalogVersionRecord
VersionRecord getVersion(java.lang.String userID, java.lang.String resourcePath, int versionNumber) throws NoPrivilegeException, UnknownResource
userID
- the user ID,resourcePath
- the resource path, for example, /COMPONENT_LIB/Test.lc.versionNumber
- the version numberVersionRecord
object. or
null if it cannot get specific versionNoPrivilegeException
- if a NoPrivilegeException occurs.UnknownResource
- if no node can be found by the pathVersionRecord
LCVersionRecord getLCVersion(java.lang.String userID, java.lang.String path, int versionNumber) throws NoPrivilegeException, UnknownResource
userID
- the user ID,path
- the LC path, for example, /COMPONENT_LIB/Test.lc.versionNumber
- the version numberLCVersionRecord
object. or
null if it cannot get the specific versionNoPrivilegeException
- if a NoPrivilegeException occurs.UnknownResource
- if no node can be found by the pathLCVersionRecord
ReportVersionRecord getReportVersion(java.lang.String userID, java.lang.String rptPath, int versionNumber) throws NoPrivilegeException, UnknownResource
userID
- the user ID,rptPath
- the report path, for example, /SampleReports/CustomerAnalysis.cls.versionNumber
- the version numberReportVersionRecord
object. or null if it cannot get the specific versionNoPrivilegeException
- if a NoPrivilegeException occurs.UnknownResource
- if no node can be found by the pathReportVersionRecord
ResultVersionRecord getResultVersion(java.lang.String userID, java.lang.String rptName, int versionNumber) throws NoPrivilegeException, UnknownResource
userID
- the user ID,rptName
- the report name, for example, /SampleReports/CustomerAnalysis.cls.versionNumber
- the version numberResultVersionRecord
object. or null if it cannot get the specific versionNoPrivilegeException
- if a NoPrivilegeException occurs.UnknownResource
- if no node can be found by the pathResultVersionRecord
ResultVersionRecord getResultVersionByNodeID(java.lang.String recordID) throws NoPrivilegeException, UnknownResource
recordID
- the node idNoPrivilegeException
UnknownResource
ResultVersionRecord
ResultVersionRecord getResultDocVersion(java.lang.String userID, java.lang.String resultDocName, int versionNumber) throws NoPrivilegeException, UnknownResource
userID
- the user ID,resultDocName
- the result doc name, for example, /SampleReports/resultdoc1.versionNumber
- the version numberResultVersionRecord
object. or null if it cannot get the specific versionNoPrivilegeException
- if a NoPrivilegeException occurs.UnknownResource
- if no node can be found by the pathResultVersionRecord
void setResultMaxVersionAmount(java.lang.String userID, java.lang.String reportResource, int maxVersionAmount) throws NoPrivilegeException, UnknownResource
userID
- the user ID.reportResource
- the report resource name, for example, /SampleReports/CustomerAnalysis.clsmaxVersionAmount
- the maximum number of versions value. If it is 0 or a negative value, the version
amount of the specific resource is unlimited.NoPrivilegeException
- if a NoPrivilegeException occurs.UnknownResource
- if no node can be found by the pathint getResultMaxVersionAmount(java.lang.String userID, java.lang.String reportResource) throws NoPrivilegeException, UnknownResource
userID
- the user ID.reportResource
- the report resource name, for example, /SampleReports/CustomerAnalysis.clsNoPrivilegeException
- if a NoPrivilegeException occurs.UnknownResource
- if no node can be found by the pathvoid removeNode(java.lang.String userID, java.lang.String path) throws NoPrivilegeException, UnknownResource
userID
- the user ID.path
- the path from which the resource will be removed.NoPrivilegeException
- if a NoPrivilegeException occurs.UnknownResource
- if no node can be found by the pathVersionRecord addResource(java.lang.String userID, java.lang.String folderPath, java.util.Hashtable htResource) throws NoPrivilegeException, NodeExistsException, UnknownResource
userID
- the user IDfolderPath
- the path of the folder in which a new resource will be addedhtResource
- a Hashtable
that contains attributes of the new resource.
These attributes can be indicated by some defined constants in APIConst,
for example, TAG_NODE_NAME, TAG_RESOURCE_TYPE, TAG_DEFINE_PERMISSION
, etc.VersionRecord
object to represent a resource version that was just added,
or null if it failed to add the resource.NoPrivilegeException
- if a NoPrivilegeException occurs.NodeExistsException
- if a NodeExistsException occurs.UnknownResource
- if no node can be found by the pathVersionRecord addResource(java.lang.String userID, java.lang.String folderPath, java.util.Hashtable htResource, java.util.Hashtable[] permissions) throws NoPrivilegeException, NodeExistsException, UnknownResource
userID
- the user IDfolderPath
- the path of the folder in which a new resource will be added.htResource
- a Hashtable
that contains attributes of the new resource.
These attributes can be indicated by some defined constants in APIConst,
for example, TAG_NODE_NAME, TAG_RESOURCE_TYPE, etc.permissions
- a Hashtable
array, which may contain three Hashtable
objects.Hashtable
contains several user/permissions pairs to represent the permissions attached to the specific path.
In this Hashtable
object, the key is user name, the value is a Vector
object which contains all permissions
(e.g. jet.server.api.Permissions.P_READ
) that the user has on the specific path. Hashtable
object contains several role/permissions pairs to represent
the defined permissions on the specific path and its structure is similar to user/permissions.Hashtable
object contains several group/permissions pairs to represent
the defined permissions on the specific path and its structure is similar to user/permissions.Permissions.P_VISIBLE
Permissions.P_READ
Permissions.P_WRITE
Permissions.P_DELETE
Permissions.P_EXECUTE
Permissions.P_SCHEDULE
Permissions.P_GRANT
VersionRecord
object to represent a resource version that was just added,
or null if failed to add the resource.NoPrivilegeException
- if a NoPrivilegeException occurs.NodeExistsException
- if a NodeExistsException occurs.UnknownResource
- if no node can be found by the pathVersionRecord addResource(java.lang.String userID, java.lang.String folderPath, boolean isAutoConvert, java.util.Hashtable htResource, java.util.Hashtable[] permissions) throws NoPrivilegeException, NodeExistsException, UnknownResource
userID
- the user IDfolderPath
- the path of the folder in which a new resource will be addedisAutoConvert
- whether to convert the old version report to the latest version reporthtResource
- a Hashtable
that contains attributes of the new resource.
These attributes can be indicated by some defined constants in APIConst,
for example, TAG_NODE_NAME, TAG_RESOURCE_TYPE, etc.permissions
- a Hashtable
array, which may contain three Hashtable
objects.Hashtable
contains several user/permissions pairs to represent the permissions attached to the specific path.
In this Hashtable
object, the key is user name, the value is a Vector
object which contains all permissions
(e.g. jet.server.api.Permissions.P_READ
) that the user has on the specific path.Hashtable
object contains several role/permissions pairs to represent
the defined permissions on the specific path and its structure is similar to user/permissions.Hashtable
object contains group/permissions pairs to represent
the defined permissions on the specific path and its structure is similar to user/permissions.Permissions.P_VISIBLE
Permissions.P_READ
Permissions.P_WRITE
Permissions.P_DELETE
Permissions.P_EXECUTE
Permissions.P_SCHEDULE
Permissions.P_GRANT
VersionRecord
object to represent a resource version that was just added,
or null if failed to add the resource.NoPrivilegeException
- if a NoPrivilegeException occurs.NodeExistsException
- if a NodeExistsException occurs.UnknownResource
- if no node can be found by the pathVersionRecord addResultInReport(java.lang.String userID, java.lang.String reportPath, java.util.Hashtable htResult) throws NoPrivilegeException, UnknownResource
userID
- the user IDreportPath
- the path of the specified report in which a new result will be addedhtResult
- a Hashtable
that contains attributes of the new result.
These attributes can be indicated by some defined constants in APIConst
,
for example, TAG_NODE_NAME, TAG_RESOURCE_TYPE, TAG_DEFINE_PERMISSION
, etc.VersionRecord
object to represent a result version that was just added,
or null if failed to add the result.NoPrivilegeException
- if a NoPrivilegeException occurs.UnknownResource
- if no node can be found by the pathjava.lang.String addFolder(java.lang.String userID, java.lang.String parentPath, java.util.Hashtable htFolder) throws NoPrivilegeException, NodeExistsException, UnknownResource
userID
- the user IDparentPath
- the path of the folder in which a new resource will be addedhtFolder
- a Hashtable
that contains attributes of the new folder.
These attributes can be indicated by some defined constants in APIConst
,
for example, TAG_NODE_NAME, TAG_DEFINE_PERMISSION
, etc.NoPrivilegeException
- if a NoPrivilegeException occurs.NodeExistsException
- if a NodeExistsException occurs.UnknownResource
- if no node can be found by the pathjava.lang.String createFolder(java.lang.String userID, java.lang.String parentPath, java.lang.String folderName, java.util.Hashtable htFolder, java.util.Hashtable[] permissions) throws NoPrivilegeException, NodeExistsException, UnknownResource
userID
- the user IDparentPath
- the path to specify in which folder the new resource will be addedfolderName
- the name of the new folderhtFolder
- a Hashtable
that contains attributes of the new folder.
These attributes can be indicated by some defined constants in APIConst
,
for example, TAG_NODE_DESC, etc.permissions
- a Hashtable
array, which may contain three Hashtable
objects.Hashtable
contains several user/permissions pairs to represent the permissions attached to the specific path.
In this Hashtable
object, the key is user name, the value is a Vector
object which contains all permissions
(e.g. jet.server.api.Permissions.P_READ
) that the user has on the specific path. Hashtable
object contains several role/permissions pairs to represent
the defined permissions on the specific path and its structure is similar to user/permissions.Hashtable
object contains several group/permissions pairs to represent
the defined permissions on the specific path and its structure is similar to user/permissions.Permissions.P_VISIBLE
Permissions.P_READ
Permissions.P_WRITE
Permissions.P_DELETE
Permissions.P_EXECUTE
Permissions.P_SCHEDULE
Permissions.P_GRANT
NoPrivilegeException
- if a NoPrivilegeException occurs.NodeExistsException
- if a NodeExistsException occurs.UnknownResource
- if no node can be found by the pathvoid addResourcesToFolder(java.lang.String userID, java.lang.String folderPath, java.lang.String fromRealDir, boolean includesSubDir, java.util.Hashtable htResource, java.util.Hashtable[] permissions) throws NoPrivilegeException, NodeExistsException, UnknownResource
userID
- the user IDfolderPath
- the path to specify in which folder new resources will be addedfromRealDir
- the real directory which contains these files and sub-folders.includesSubDir
- indicates to only add files to the folder.htResource
- a Hashtable
that contains attributes of the new resources.
These attributes can be indicated by some defined constants in APIConst
,
for example, TAG_NODE_NAME, TAG_RESOURCE_TYPE, etc.permissions
- a Hashtable
array, which may contain three Hashtable
objects.Hashtable
contains several user/permissions pairs to represent the permissions attached to the specific path.
In this Hashtable
object, the key is user name, the value is a Vector
object which contains all permissions
(e.g. jet.server.api.Permissions.P_READ) that the user has on the specific path.Hashtable
object contains several role/permissions pairs to represent
the defined permissions on the specific path and its structure is similar to user/permissions.Hashtable
object contains several group/permissions pairs to represent
the defined permissions on the specific path and its structure is similar to user/permissions.Permissions.P_VISIBLE
Permissions.P_READ
Permissions.P_WRITE
Permissions.P_DELETE
Permissions.P_EXECUTE
Permissions.P_SCHEDULE
Permissions.P_GRANT
NoPrivilegeException
- if a NoPrivilegeException occurs.NodeExistsException
- if a NodeExistsException occurs.UnknownResource
- if no node can be found by the pathjava.lang.String addResourcesToFolder(java.lang.String userID, java.lang.String folderPath, java.lang.String fromRealDir, boolean includesSubDir, boolean isAutoConvert, java.util.Hashtable htResource, java.util.Hashtable[] permissions) throws NoPrivilegeException, NodeExistsException, UnknownResource
userID
- the user IDfolderPath
- the path to specify in which folder the new resources will be addedfromRealDir
- the real directory which contains these files and sub-folders.includesSubDir
- indicates to only add files to the folder.isAutoConvert
- whether to convert the old version report to the latest version reporthtResource
- a Hashtable
that contains attributes of the new resources.
These attributes can be indicated by some defined constants in APIConst
,
for example, TAG_NODE_NAME, TAG_RESOURCE_TYPE, etc.permissions
- a Hashtable
array, which may contain three Hashtable
objects.Hashtable
contains several user/permissions pairs to represent the permissions attached to the specific path.
In this Hashtable
object, the key is user name, the value is a Vector
object which contains all permissions
(e.g. jet.server.api.Permissions.P_READ
) that the user has on the specific path.Hashtable
object contains several role/permissions pairs to represent
the defined permissions on the specific path and its structure is similar to user/permissions.Hashtable
object contains several group/permissions pairs to represent
the defined permissions on the specific path and its structure is similar to user/permissions.
The structure of Hashtable[] permissions is:
Permissions.P_VISIBLE
Permissions.P_READ
Permissions.P_WRITE
Permissions.P_DELETE
Permissions.P_EXECUTE
Permissions.P_SCHEDULE
Permissions.P_GRANT
NoPrivilegeException
- if a NoPrivilegeException occurs.NodeExistsException
- if a NodeExistsException occurs.UnknownResource
- if no node can be found by the pathvoid removeVersion(java.lang.String userID, java.lang.String versionID) throws NoPrivilegeException
userID
- the user IDversionID
- the version ID to be removed. User can get it from
VersionRecord
.NoPrivilegeException
- if a NoPrivilegeException occurs.VersionRecord
java.util.Vector getAllUsers(java.lang.String submitter)
submitter
- the user id who sent this requestVector
object containing all user names, or null if
the submitter does not have the permission for getting all users.java.util.Vector getUsersByRole(java.lang.String submitter, java.lang.String roleID) throws NoSuchRoleException
submitter
- the user id who sent this requestroleID
- the role IDVector
object containing the user names who have the specific role,
or null if the submitter does not have the permission for getting the users by this role.NoSuchRoleException
- if a NoPrivilegeException occurs.java.util.Vector getAllRoles(java.lang.String submitter)
submitter
- the user id who sent this requestVector
object containing all role names, or null if
the submitter does not have the permission for getting all roles.java.util.Vector getRolesByUser(java.lang.String submitter, java.lang.String userID) throws NoSuchUserException
submitter
- the user id who sent this requestuserID
- the user IDVector
object containing the role names which the specific user has,
or null if the submitter does not have the permission for getting the roles by this user.NoSuchUserException
- if a NoSuchUserException occursjava.util.Vector getReferRoles(java.lang.String userID) throws NoSuchUserException
userID
- the user IDVector
object containing the role names which the specific user belongs to.
These roles are owned by the specific user but not administrator or everyone.NoSuchUserException
- if a NoSuchUserException occursjava.util.Vector getReferUsers(java.lang.String userID) throws NoSuchUserException
userID
- the user IDVector
object containing the user names that have the same role.NoSuchUserException
- if a NoSuchUserException occursjava.util.Vector getReferGroups(java.lang.String userID) throws NoSuchUserException
userID
- the user IDVector
object containing the group names which the specific user belongs to,NoSuchUserException
- if a NoSuchUserException occursjava.util.Hashtable[] getPermissions(java.lang.String userID, java.lang.String path, int versionNumber) throws NoPrivilegeException, UnknownResource
userID
- the user ID whose permissions are to getpath
- the path which the user is attached toversionNumber
- the version number to specify the version of the path, if its value
is 0, get the latest version.Hashtable
array, which contains three Hashtable
objects to represent
permissions set on the path. null
means no permission set on the path.
The first Hashtable
contains several user/permissions pairs to represent the defined permissions
attached to the specific path. In this Hashtable
object, the key is user name,
the value is a String
which presents the permissions that the user has on the specific path.
In the value string, character '1' and '0' respectively represents Allow and Deny,
the position indicates which privilege it stand for (0 base):
The second Hashtable
object contains several role/permissions
pairs to represent the defined permissions on the specific path and its structure is similar to user/permissions.
The third Hashtable
object contains several group/permissions pairs to represent
the defined permissions on the specific path and its structure is similar to user/permissions.
NoPrivilegeException
- if a NoPrivilegeException occurs.UnknownResource
- if no node can be found by the pathjava.util.Hashtable[] getInheritedPermissions(java.lang.String userID, java.lang.String path, int versionNumber) throws NoPrivilegeException, UnknownResource
userID
- the user ID whose permissions are to getpath
- the path which the user is attached toversionNumber
- version number to specify the version of the path, if its value
is 0, get the latest version.Hashtable
array, which contains three Hashtable
objects. The first
Hashtable
contains several user/permissions pairs to represent the defined permissions attached to the specific path.
In this Hashtable
object, the key is user name, the value is a Vector
object which contains all permissions
(e.g. jet.server.api.Permissions.P_READ) that the user has on the specific path.
The second Hashtable
object contains several role/permissions pairs to represent
the inherited permissions on the specific path and its structure is similar to user/permissions.
The third Hashtable
object contains several group/permissions pairs to represent
the inherited permissions on the specific path and its structure is similar to user/permissions.
Or null if the user/role/group does not have the permission to get the permissions on the specific path.NoPrivilegeException
- if a NoPrivilegeException occurs.UnknownResource
- if no node can be found by the pathvoid setPermissions(java.lang.String userID, java.lang.String path, int versionNumber, java.util.Hashtable[] permissions) throws NoPrivilegeException, UnknownResource
userID
- the user ID whose permissions are to setpath
- the path which will be set attached permissionsversionNumber
- version number to specify the version of the path, if its value
is 0, get the latest version.permissions
- a Hashtable
array, which contains three Hashtable
objects to represent
permissions set on the path.
The first Hashtable
contains several user/permissions pairs to represent the defined permissions
attached to the specific path. In this Hashtable
object, the key is user name,
the value is a String
which presents the permissions that the user has on the specific path.
In the value string, character '1' and '0' respectively represents Allow and Deny,
the position indicates which privilege it stand for (0 base):
The second Hashtable
object contains several role/permissions
pairs to represent the defined permissions on the specific path and its structure is similar to user/permissions.
The third Hashtable
object contains several group/permissions pairs to represent
the defined permissions on the specific path and its structure is similar to user/permissions.
NoPrivilegeException
- if a NoPrivilegeException occurs.UnknownResource
- if no node can be found by the pathvoid setNodeProperties(java.lang.String userID, java.lang.String path, java.util.Hashtable htProps, java.util.Hashtable[] permissions) throws NoPrivilegeException, NodeExistsException, UnknownResource
userID
- the user ID whose properties are to setpath
- the path which will be used to set properties and permissionshtProps
- properties of the specific node. These properties are indicated by
APIConst.TAG_MAXVERSION, APIConst.TAG_REPLACE_OLD_VERSION, APIConst.TAG_NODE_REAL_PATH,
APIConst.TAG_TAG_ENABLE_DEFAULT_LINKED_CATALOG, APIConst.TAG_DEFAULT_LINKED_CATALOG
APIConst.TAG_IS_USING_INHERITED
, etc.
all values are represented by a String
.permissions
- a Hashtable
array, which may contain three Hashtable
objects.Hashtable
contains several user/permissions pairs to represent the permissions attached to the specific path.
In this Hashtable
object, the key is user name, the value is a Vector
object which contains all permissions
(e.g. jet.server.api.Permissions.P_READ) that the user has on the specific path. Hashtable
object contains several role/permissions pairs to represent
the defined permissions on the specific path and its structure is similar to user/permissions.Hashtable
object contains several group/permissions pairs to represent
the defined permissions on the specific path and its structure is similar to user/permissions.
The structure of Hashtable[] permissions is:
Permissions.P_VISIBLE
Permissions.P_READ
Permissions.P_WRITE
Permissions.P_DELETE
Permissions.P_EXECUTE
Permissions.P_SCHEDULE
Permissions.P_GRANT
NoPrivilegeException
- if a NoPrivilegeException occurs.NodeExistsException
- if a NodeExistsException occurs.UnknownResource
- if an UnknownResource occurs.void setNodeProperties(java.lang.String userID, java.lang.String path, int versionNumber, java.util.Hashtable htProps, java.util.Hashtable[] permissions) throws NoPrivilegeException, UnknownResource
userID
- the user ID whose properties are to setpath
- the path which will be set properties and permissions for
attached versionversionNumber
- the version number. If it is zero, it means the path itselfhtProps
- the properties of the specific node. These properties are indicated by
APIConst.TAG_EXPIRED_TIME
, etc, and all values are represented by
a String
.permissions
- a Hashtable
array, which may contain three
Hashtable
objects. The first
Hashtable
contains several user/permissions
pairs to represent the permissions attached to the specific path.Hashtable
object, the key is user name, the value
is a Vector
object which contains all
permissions (e.g. jet.server.api.Permissions.P_READ
) that the
user has on the specific path.Hashtable
object contains several role/permissions pairs to represent
the defined permissions on the specific path and its structure is
similar to user/permissions.Hashtable
object contains several group/permissions pairs to represent
the defined permissions on the specific path and its structure is
similar to user/permissions.Permissions.P_VISIBLE
Permissions.P_READ
Permissions.P_WRITE
Permissions.P_DELETE
Permissions.P_EXECUTE
Permissions.P_SCHEDULE
Permissions.P_GRANT
NoPrivilegeException
- if a NoPrivilegeException occurs.UnknownResource
- if an UnknownResource occurs.void setResultVersionProperties(java.lang.String userID, java.lang.String report, int versionNumber, java.util.Hashtable htProps) throws NoPrivilegeException, UnknownResource
userID
- the user ID whose properties are to setreport
- the report which will be set properties for the attached result versionversionNumber
- the version number. If it is zero or an invalid version number, no action will be performed.htProps
- the properties of the specific node. These properties are indicated by
APIConst.TAG_EXPIRED_TIME
, etc, and
all values are represented by a String
.NoPrivilegeException
- if a NoPrivilegeException occurs.UnknownResource
- if an UnknownResource occurs.java.lang.String getRealPathOfNode(java.lang.String userID, java.lang.String path) throws NoPrivilegeException, UnknownResource
userID
- the user idpath
- the path to specify a node (a folder, catalog, or report)NoPrivilegeException
- if the user does not have the permission to get the specific node's realPathUnknownResource
- if no node can be found by the pathjava.lang.String refreshFolders(java.lang.String userID)
#getResourceTreeInputStream(String)
userID
- the user id.java.io.InputStream getResourceTreeInputStream(java.lang.String userID, java.lang.String... pathPrefix)
userID
- the user id.pathPrefix
- root path prefix, such as /(Public Reports), /USERFOLDERPATH,
/COMPONENT_LIB etc.java.io.InputStream getResourceTreeInputStreamByType(java.lang.String userID, int streamType, java.lang.String... pathPrefix)
userID
- the user id.streamType
- the type of return stream, XML_STREAM indicate return XML text stream,
JSON_STREAM indicate return JSON text stream, other type return null.pathPrefix
- root path prefix, such as /(Public Reports), /USERFOLDERPATH,
/COMPONENT_LIB etc.java.io.InputStream getResourceTreeInputStream(java.lang.String userID, int streamType, java.lang.String[] roots, java.lang.String[] suffixes, java.util.Locale locale)
userID
- the user id.streamType
- the type of return stream, XML_STREAM indicate return XML text stream,
JSON_STREAM indicate return JSON text stream, other type return null.root
- root paths , such as /(Public Reports), /USERFOLDERPATH,
/COMPONENT_LIB etc.roots
- root paths , such as /(Public Reports), /USERFOLDERPATH,
/COMPONENT_LIB etc.suffixes
- resource suffix, such as ".cls", ".dsh", etc.int getLatestVersionNumber(java.lang.String resourcePath) throws UnknownResource
resourcePath
- resource path to specify a resourceUnknownResource
- if no node can be found by the pathint getLatestVersionNumber(java.lang.String resourcePath, java.lang.String userID) throws UnknownResource
resourcePath
- resource path to specify a resourceuserID
- the user idUnknownResource
- if no node can be found by the pathboolean isAdminUser(java.lang.String userID)
userID
- the user idboolean isOrganizationAdminUser(java.lang.String userID)
userID
- the user idboolean checkPermission(java.lang.String userID, java.lang.String resourcePath, java.security.acl.Permission permission) throws NoSuchUserException, UnknownResource
userID
- the user id.resourcePath
- the resourc path.permission
- a permission, which should be one of the permissions defined in jet.server.api.Permissions.NoSuchUserException
- if NoSuchUserException occurs.UnknownResource
- if no node can be found by the path.boolean checkPermission(java.lang.String userID, java.lang.String resourcePath, int versionNumber, java.security.acl.Permission permission) throws NoSuchUserException, UnknownResource
userID
- the user id.resourcePath
- the resource path.versionNumber
- the version number of the resource path.permission
- a permission, which should be one of the permissions defined in jet.server.api.Permissions.NoSuchUserException
- if NoSuchUserException occursUnknownResource
- if no node can be found by the pathboolean isNodeExist(java.lang.String path, java.lang.String userName)
path
- the specific resource path.userName
- the user name.void loadUserResAliasToMem(java.lang.String userID)
userID
- the user name.java.rmi.RemoteException
void rmUserResAliasFromMem(java.lang.String userID)
userID
- the user name.java.lang.String getInheritedLinkedCatalog(java.lang.String userID, java.lang.String path) throws NoPrivilegeException, UnknownResource
userID
- the user name.path
- the resource path.NoPrivilegeException
UnknownResource
boolean isCatalogLinked(java.lang.String userID, java.lang.String path) throws NoPrivilegeException, UnknownResource
userID
- the user name.path
- the catalog path.NoPrivilegeException
UnknownResource
java.util.Vector getEnabledCustomFieldNames()
RptServerException
- if an RptServerException occurs.java.lang.String getRootNodeDisplay(java.util.Locale locale)
locale
- the localeResourceNLSManager.updateRootNLSEntry(Locale, TextNLSEntry, String)
,
return null if not defined.ResourceNLSManager
SearchHelper getSearchHelper(int helperId)
helperId
- The id of a search helper. For the first use, can pass -1.