A C D E F G H I J P R S U V W X 
All Classes All Packages

A

addLog(JobResult) - Method in class com.xwiki.admintools.jobs.PackageUploadJobStatus
Add a new log to the job results.
addZipEntry(ZipOutputStream, Map<String, String[]>) - Method in interface com.xwiki.admintools.download.DataResource
Retrieves the content of a system file and adds it as an entry inside a ZipOutputStream.
AdminToolsConfiguration - Interface in com.xwiki.admintools.configuration
Admin Tools configurations.
AdminToolsResource - Interface in com.xwiki.admintools.rest
Provides the APIs needed by the Admin Tools server in order to download and view configuration files and logs.

C

check() - Method in interface com.xwiki.admintools.health.HealthCheck
Execute the health check on the wiki instance.
com.xwiki.admintools - package com.xwiki.admintools
 
com.xwiki.admintools.configuration - package com.xwiki.admintools.configuration
 
com.xwiki.admintools.download - package com.xwiki.admintools.download
 
com.xwiki.admintools.health - package com.xwiki.admintools.health
 
com.xwiki.admintools.jobs - package com.xwiki.admintools.jobs
 
com.xwiki.admintools.rest - package com.xwiki.admintools.rest
 
com.xwiki.admintools.security - package com.xwiki.admintools.security
 
com.xwiki.admintools.uploadPackageJob - package com.xwiki.admintools.uploadPackageJob
 
com.xwiki.admintools.usage - package com.xwiki.admintools.usage
 

D

DataProvider - Interface in com.xwiki.admintools
Gathers specific data and returns it in a specific format, using a template.
DataResource - Interface in com.xwiki.admintools.download
Access server files.

E

equals(Object) - Method in class com.xwiki.admintools.security.RightsResult
 
ERROR - com.xwiki.admintools.jobs.JobResultLevel
Used to mark a JobResultLevel as an error.

F

FAIL - com.xwiki.admintools.jobs.JobResultLevel
This is used to mark a job failure.
flushCache() - Method in interface com.xwiki.admintools.rest.AdminToolsResource
Flush the cache of the XWiki instance, including all wikis, plugins and renderers.
foundServerPath() - Method in interface com.xwiki.admintools.ServerInfo
Verify if the path to a specific server is found.

G

getAttachmentsCount() - Method in interface com.xwiki.admintools.usage.WikiUsageResult
Get the number of attachments in this wiki.
getAttachmentsSize() - Method in interface com.xwiki.admintools.usage.WikiUsageResult
Get the total size of the attachments.
getBackupFile() - Method in class com.xwiki.admintools.uploadPackageJob.UploadPackageJobResource
The original file backup created before the uploading process began.
getByteData(Map<String, String[]>) - Method in interface com.xwiki.admintools.download.DataResource
Retrieve the content of a system file.
getComponentHint() - Method in interface com.xwiki.admintools.ServerInfo
Extract the hint of a component.
getDataAsJSON() - Method in interface com.xwiki.admintools.DataProvider
Provides the info structured in a json.
getDocReference() - Method in class com.xwiki.admintools.security.RightsResult
Retrieves the reference of the document where rights are stored.
getDocumentsCount() - Method in interface com.xwiki.admintools.usage.WikiUsageResult
Get the number of documents in this wiki.
getEntity() - Method in class com.xwiki.admintools.security.RightsResult
Retrieves the entity for which rights are checked.
getExcludedLines() - Method in interface com.xwiki.admintools.configuration.AdminToolsConfiguration
Get the lines that are to be excluded from xwiki.cfg and xwiki.properties files.
getFile(String) - Method in interface com.xwiki.admintools.rest.AdminToolsResource
Access the content of a specific file, based on received type.
getFileRef() - Method in class com.xwiki.admintools.jobs.PackageUploadJobRequest
Get the attachment reference.
getFiles() - Method in interface com.xwiki.admintools.rest.AdminToolsResource
Download an archive with the requested files.
getIdentifier() - Method in interface com.xwiki.admintools.DataProvider
Extract the hint of a component.
getIdentifier() - Method in interface com.xwiki.admintools.download.DataResource
Get the hint of a component.
getJobID() - Method in class com.xwiki.admintools.jobs.PackageUploadJobStatus
Get the ID for the job.
getJobResults() - Method in class com.xwiki.admintools.jobs.HealthCheckJobStatus
Get the list issues list from the job.
getJobResults() - Method in class com.xwiki.admintools.jobs.PackageUploadJobStatus
Get the list result list from the job.
getLastLogFilePath() - Method in interface com.xwiki.admintools.ServerInfo
Get path to server last updated main log file.
getLevel() - Method in class com.xwiki.admintools.jobs.JobResult
Get the severity level a detected error.
getLevel() - Method in class com.xwiki.admintools.security.RightsResult
Get the stored level of security.
getLogsFolderPath() - Method in interface com.xwiki.admintools.ServerInfo
Get path to server logs folder.
getLogsHint() - Method in interface com.xwiki.admintools.ServerInfo
Get server logs common identifier.
getLogsPattern() - Method in interface com.xwiki.admintools.ServerInfo
Get server pattern for identifying log files date.
getMessage() - Method in class com.xwiki.admintools.jobs.JobResult
Get the error body.
getNewFilename() - Method in class com.xwiki.admintools.uploadPackageJob.UploadPackageJobResource
Get the new file name.
getParameters() - Method in class com.xwiki.admintools.jobs.JobResult
Get the recommendation for the set error.
getPolicy() - Method in class com.xwiki.admintools.security.RightsResult
Get the rights level policy.
getRenderedData() - Method in interface com.xwiki.admintools.DataProvider
Provides the data provider information in a format given by the associated template.
getServerCfgPath() - Method in interface com.xwiki.admintools.ServerInfo
Access the path to the server configuration file.
getServerPath() - Method in interface com.xwiki.admintools.configuration.AdminToolsConfiguration
Get the server installation path.
getServerPath() - Method in interface com.xwiki.admintools.ServerInfo
Get path to server.
getSpace() - Method in class com.xwiki.admintools.security.RightsResult
Get the space where the document is located.
getSpamSize() - Method in interface com.xwiki.admintools.configuration.AdminToolsConfiguration
Get the number of comments that are used for a page to be considered spam.
getTargetFile() - Method in class com.xwiki.admintools.uploadPackageJob.UploadPackageJobResource
Retrieves the file that serves as the target for the update process.
getTotal() - Method in interface com.xwiki.admintools.usage.WikiUsageResult
Get the total number of documents and attachments.
getType() - Method in class com.xwiki.admintools.security.RightsResult
Get the type of rights.
getUserCount() - Method in interface com.xwiki.admintools.usage.WikiUsageResult
Get the number of users registered in the wiki.
getVersion() - Method in enum com.xwiki.admintools.health.XWikiVersions
Get the XWiki version represented by the enum value.
getWikiName() - Method in interface com.xwiki.admintools.usage.WikiUsageResult
Get the name of the wiki.
getXwikiCfgFolderPath() - Method in interface com.xwiki.admintools.ServerInfo
Access the path to the XWiki configuration folder.
getXWikiInstallFolderPath() - Method in interface com.xwiki.admintools.ServerInfo
Access the path to the XWiki installation folder.
getXWikiInstallLocation() - Method in interface com.xwiki.admintools.configuration.AdminToolsConfiguration
Get the XWiki install path.

H

hashCode() - Method in class com.xwiki.admintools.security.RightsResult
 
hasLevel(JobResultLevel) - Method in class com.xwiki.admintools.jobs.HealthCheckJobStatus
Check if any job result has a specific level of severity.
hasLevel(JobResultLevel) - Method in class com.xwiki.admintools.jobs.PackageUploadJobStatus
Check if any job result has a specific level of severity.
HealthCheck - Interface in com.xwiki.admintools.health
Check for issues in the current wiki.
HealthCheckJobRequest - Class in com.xwiki.admintools.jobs
Represents a request to start a health check on current wiki.
HealthCheckJobRequest() - Constructor for class com.xwiki.admintools.jobs.HealthCheckJobRequest
Default constructor.
HealthCheckJobRequest(List<String>) - Constructor for class com.xwiki.admintools.jobs.HealthCheckJobRequest
Creates a request specific to the wiki from which the call was made.
HealthCheckJobStatus - Class in com.xwiki.admintools.jobs
The status of the health check job.
HealthCheckJobStatus(String, HealthCheckJobRequest, ObservationManager, LoggerManager) - Constructor for class com.xwiki.admintools.jobs.HealthCheckJobStatus
Create a new health check job status.

I

INFO - com.xwiki.admintools.jobs.JobResultLevel
Used to mark a JobResultLevel as informative.

J

JobResult - Class in com.xwiki.admintools.jobs
Result of a job.
JobResult(String, JobResultLevel, Object...) - Constructor for class com.xwiki.admintools.jobs.JobResult
Used for registering a result.
JobResultLevel - Enum in com.xwiki.admintools.jobs
Represents the severity level of a job, where "INFO" is for informative results, "WARN" for warnings, "ERROR" for severe issues and "FAIL" for job failures.

P

PackageUploadJobRequest - Class in com.xwiki.admintools.jobs
Represents a request to start a package upload job.
PackageUploadJobRequest() - Constructor for class com.xwiki.admintools.jobs.PackageUploadJobRequest
Default constructor.
PackageUploadJobRequest(String, List<String>) - Constructor for class com.xwiki.admintools.jobs.PackageUploadJobRequest
Creates a specific request for package upload job.
PackageUploadJobStatus - Class in com.xwiki.admintools.jobs
The status of a package upload job.
PackageUploadJobStatus(String, PackageUploadJobRequest, ObservationManager, LoggerManager) - Constructor for class com.xwiki.admintools.jobs.PackageUploadJobStatus
Create a new upload job status.

R

RightsResult - Class in com.xwiki.admintools.security
Stores needed information from the groups and users rights processing.
RightsResult() - Constructor for class com.xwiki.admintools.security.RightsResult
Default constructor.
RightsResult(String) - Constructor for class com.xwiki.admintools.security.RightsResult
Constructor with type parameter.

S

ServerInfo - Interface in com.xwiki.admintools
Exposes methods for accessing server specific information, like configurations, logs or other XWiki and server files.
setAttachmentsCount(Long) - Method in interface com.xwiki.admintools.usage.WikiUsageResult
Set the number attachments in this wiki.
setAttachmentsSize(Long) - Method in interface com.xwiki.admintools.usage.WikiUsageResult
Set the total size of the attachments.
setBackupFile(File) - Method in class com.xwiki.admintools.uploadPackageJob.UploadPackageJobResource
See UploadPackageJobResource.getBackupFile().
setDocReference(DocumentReference) - Method in class com.xwiki.admintools.security.RightsResult
See getDocReference().
setDocumentsCount(Long) - Method in interface com.xwiki.admintools.usage.WikiUsageResult
Set the number of documents in this wiki.
setEntity(String) - Method in class com.xwiki.admintools.security.RightsResult
See getEntity().
setLevel(String) - Method in class com.xwiki.admintools.security.RightsResult
See getLevel().
setNewFilename(String) - Method in class com.xwiki.admintools.uploadPackageJob.UploadPackageJobResource
See UploadPackageJobResource.getNewFilename().
setPolicy(String) - Method in class com.xwiki.admintools.security.RightsResult
See getPolicy().
setSpace(String) - Method in class com.xwiki.admintools.security.RightsResult
See getSpace().
setTargetFile(File) - Method in class com.xwiki.admintools.uploadPackageJob.UploadPackageJobResource
See UploadPackageJobResource.getTargetFile().
setType(String) - Method in class com.xwiki.admintools.security.RightsResult
See getType().
setUserCount(Long) - Method in interface com.xwiki.admintools.usage.WikiUsageResult
Set the number of users registered in the wiki.
setWikiName(String) - Method in interface com.xwiki.admintools.usage.WikiUsageResult
Set the name of the wiki.

U

updatePossiblePaths() - Method in interface com.xwiki.admintools.ServerInfo
Update the possible paths to the configuration files.
uploadPackageArchive(String, String) - Method in interface com.xwiki.admintools.rest.AdminToolsResource
Start a package upload job based on the attachment reference that was sent.
UploadPackageJobResource - Class in com.xwiki.admintools.uploadPackageJob
Store data for package upload job process.
UploadPackageJobResource() - Constructor for class com.xwiki.admintools.uploadPackageJob.UploadPackageJobResource
Default constructor.

V

valueOf(String) - Static method in enum com.xwiki.admintools.health.XWikiVersions
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.xwiki.admintools.jobs.JobResultLevel
Returns the enum constant of this type with the specified name.
values() - Static method in enum com.xwiki.admintools.health.XWikiVersions
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.xwiki.admintools.jobs.JobResultLevel
Returns an array containing the constants of this enum type, in the order they are declared.

W

WARN - com.xwiki.admintools.jobs.JobResultLevel
Used to mark a JobResultLevel as a warning.
WikiUsageResult - Interface in com.xwiki.admintools.usage
General interface for gathering info about a wiki.

X

XWIKI_11_3 - com.xwiki.admintools.health.XWikiVersions
XWiki version 11.3.0.
XWIKI_14_0 - com.xwiki.admintools.health.XWikiVersions
XWiki version 14.0.0.
XWIKI_14_10_9 - com.xwiki.admintools.health.XWikiVersions
XWiki version 14.10.9.
XWIKI_15_3 - com.xwiki.admintools.health.XWikiVersions
XWiki version 15.3.0.
XWIKI_16_0 - com.xwiki.admintools.health.XWikiVersions
XWiki version 16.0.0.
XWIKI_17_0 - com.xwiki.admintools.health.XWikiVersions
XWiki version 17.0.0.
XWIKI_8_1 - com.xwiki.admintools.health.XWikiVersions
XWiki version 8.1.0.
XWikiVersions - Enum in com.xwiki.admintools.health
Main XWiki versions.
A C D E F G H I J P R S U V W X 
All Classes All Packages