Package net.webpdf.wsclient.session.rest.administration

Class AbstractAdministrationManager<T_REST_DOCUMENT extends RestDocument>

java.lang.Object

net.webpdf.wsclient.session.rest.administration.AbstractAdministrationManager<T_REST_DOCUMENT>

All Implemented Interfaces:

AdministrationManager<T_REST_DOCUMENT>

Direct Known Subclasses:

RestAdministrationManager

public class AbstractAdministrationManager<T_REST_DOCUMENT extends RestDocument>
extends Object
implements AdministrationManager<T_REST_DOCUMENT>

Method Summary

Modifier and Type	Method	Description
void	buildSupportPackage(@NotNull File target)	Collects a set of support information, that may simplify finding the cause and solution of issues.
void	buildSupportPackage(@NotNull File target, @Nullable AdminSupportEntryGroup[] group)	Collects a set of support information, that may simplify finding the cause and solution of issues.
void	buildSupportPackage(@NotNull File target, @Nullable AdminSupportEntryGroup[] group, @Nullable Date start, @Nullable Date end)	Collects a set of support information, that may simplify finding the cause and solution of issues.
void	buildSupportPackage(@NotNull OutputStream outputStream)	Collects a set of support information, that may simplify finding the cause and solution of issues.
void	buildSupportPackage(@NotNull OutputStream outputStream, @Nullable AdminSupportEntryGroup[] group)	Collects a set of support information, that may simplify finding the cause and solution of issues.
void	buildSupportPackage(@NotNull OutputStream outputStream, @Nullable AdminSupportEntryGroup[] group, @Nullable Date start, @Nullable Date end)	Collects a set of support information, that may simplify finding the cause and solution of issues.
void	closeSession(@NotNull String sessionId)	Closes the session with the specified ID, by activating the session expiration.
void	deleteDatastore(@NotNull AdminFileGroupDataStore group)	Deletes a file, depending on the selected AdminFileGroupDataStore, from the server's data store.
void	deleteDatastore(@NotNull AdminFileGroupDataStore group, @Nullable String filename)	Deletes a file, depending on the selected AdminFileGroupDataStore, from the server's data store.
@NotNull ApplicationConfigApplication	fetchApplicationConfiguration()	Gets the ApplicationConfigApplication configuration from the server updating the cached configuration.
@NotNull Map<String,AdminConnectorKeyStore>	fetchConnectorKeyStore()	Gets the from the server updating the cached keystore.
AdminFileDataStore	fetchDatastore(@NotNull AdminFileGroupDataStore group)	Retrieves a file, depending on the selected AdminFileGroupDataStore, from the server's data store.
AdminFileDataStore	fetchDatastore(@NotNull AdminFileGroupDataStore group, @Nullable String filename)	Retrieves a file, depending on the selected AdminFileGroupDataStore, from the server's data store.
@NotNull AdminGlobalKeyStore	fetchGlobalKeyStore()	Gets the AdminGlobalKeyStore of the server updating the cached keystore.
@NotNull String	fetchLog()	Returns the contents of the current log file of the server.
@NotNull String	fetchLog(@NotNull String range)	Returns the contents of the current log file of the server.
@NotNull String	fetchLog(@NotNull String range, @Nullable Date date)	Returns the contents of the current log or a specific log file of the server.
@NotNull AdminLogFileConfiguration	fetchLogConfiguration()	Gets the AdminLogFileConfiguration from the server updating the cached configuration.
@NotNull Integer	fetchLogLength()	Returns the byte size of the current log file of the server.
@NotNull Integer	fetchLogLength(@Nullable Date date)	Returns the byte size of the current log or a specific log file of the server.
@NotNull ServerConfigServer	fetchServerConfiguration()	Gets the ServerConfigServer configuration from the server updating the cached configuration.
@NotNull AdminStatistic	fetchServerStatistic(@NotNull AdminDataSourceServerState dataSource, @NotNull AdminAggregationServerState aggregation, @NotNull List<Webservice> webservices, @NotNull Date start, @NotNull Date end)	(Experimental Web service)
@NotNull AdminServerStatus	fetchServerStatus()	Provides status information about the server, the JVM and the Web services.
@NotNull SessionTable	fetchSessionTable()	Returns the session table from server with detailed status information about each session.
@NotNull AdminTrustStoreKeyStore	fetchTrustStoreKeyStore()	Gets the AdminTrustStoreKeyStore from the server updating the cached keystore.
@NotNull UserConfigUsers	fetchUserConfiguration()	Gets the UserConfigUsers configuration of the server updating the cached configuration.
@NotNull ApplicationConfigApplication	getApplicationConfiguration()	Gets the cached ApplicationConfigApplication configuration of the server or fetches via AdministrationManager.fetchApplicationConfiguration() if cache is empty
@NotNull Map<String,AdminConnectorKeyStore>	getConnectorKeyStore()	Gets the cached AdminConnectorKeyStores of the server or fetches via AdministrationManager.fetchConnectorKeyStore() if cache is empty
@NotNull AdminGlobalKeyStore	getGlobalKeyStore()	Gets the cached AdminGlobalKeyStore of the server or fetches via AdministrationManager.fetchGlobalKeyStore() if cache is empty
@NotNull AdminLogFileConfiguration	getLogConfiguration()	Gets the cached AdminLogFileConfiguration configuration of the server or fetches via AdministrationManager.fetchLogConfiguration() if cache is empty
@NotNull ServerConfigServer	getServerConfiguration()	Gets the cached ServerConfigServer configuration of the server or fetches via AdministrationManager.fetchServerConfiguration() if cache is empty
@NotNull RestSession<T_REST_DOCUMENT>	getSession()	Returns the RestSession used by this AdministrationManager.
@NotNull AdminTrustStoreKeyStore	getTrustStoreKeyStore()	Gets the cached AdminTrustStoreKeyStore configuration of the server or fetches via AdministrationManager.fetchTrustStoreKeyStore() if cache is empty
@NotNull UserConfigUsers	getUserConfiguration()	Gets the cached UserConfigUsers configuration of the server or fetches via AdministrationManager.fetchUserConfiguration() if cache is empty
void	restartServer()	Restarts the server.
void	setConnectorKeyStore(@NotNull Map<String,AdminConnectorKeyStore> keystore)	Sets the AdminConnectorKeyStore of the server.
void	setGlobalKeyStore(@NotNull AdminGlobalKeyStore keystore)	Sets the AdminGlobalKeyStore of the server.
void	setTrustStoreKeyStore(@NotNull AdminTrustStoreKeyStore keystore)	Sets the AdminTrustStoreKeyStore of the server.
@NotNull AdminConfigurationResult	testExecutables(@NotNull ApplicationConfigApplication configuration, @NotNull List<AdminExecutableName> executables)	This is a shortcut function to validate ApplicationConfigApplication configuration executables
@NotNull AdminConfigurationResult	updateApplicationConfiguration(@NotNull ApplicationConfigApplication configuration)	Updates the ApplicationConfigApplication configuration if no AdminConfigurationResult.getError() occured.
@NotNull AdminConfigurationResult	updateApplicationConfiguration(@NotNull ApplicationConfigApplication configuration, @NotNull List<AdminApplicationCheck> checks)	Updates the ApplicationConfigApplication configuration if no AdminConfigurationResult.getError() occured.
void	updateDatastore(@NotNull AdminFileDataStore fileDataStore)	Updates a file in the server's data store.
@NotNull AdminConfigurationResult	updateLogConfiguration(@NotNull AdminLogFileConfiguration configuration)	Updates the AdminLogFileConfiguration if no AdminConfigurationResult.getError() occured.
@NotNull AdminConfigurationResult	updateLogConfiguration(@NotNull AdminLogFileConfiguration configuration, @NotNull List<AdminLogCheck> checks)	Updates the AdminLogFileConfiguration if no AdminConfigurationResult.getError() occured.
@NotNull AdminConfigurationResult	updateServerConfiguration(@NotNull ServerConfigServer configuration)	Updates the ServerConfigServer configuration if no AdminConfigurationResult.getError() occured.
@NotNull AdminConfigurationResult	updateServerConfiguration(@NotNull ServerConfigServer configuration, @NotNull List<AdminServerCheck> checks)	Updates the ServerConfigServer configuration if no AdminConfigurationResult.getError() occured.
@NotNull AdminConfigurationResult	updateUserConfiguration(@NotNull UserConfigUsers configuration)	Updates the UserConfigUsers configuration if no AdminConfigurationResult.getError() occured.
@NotNull AdminConfigurationResult	updateUserConfiguration(@NotNull UserConfigUsers configuration, @NotNull List<AdminUserCheck> checks)	Updates the UserConfigUsers configuration if no AdminConfigurationResult.getError() occured.
@NotNull AdminConfigurationResult	validateApplicationConfiguration(@NotNull ApplicationConfigApplication configuration, @NotNull List<AdminApplicationCheck> checks)	Validates the ApplicationConfigApplication configuration with the given AdminApplicationChecks.
@NotNull AdminConfigurationResult	validateLogConfiguration(@NotNull AdminLogFileConfiguration configuration, @NotNull List<AdminLogCheck> checks)	Validates the AdminLogFileConfiguration configuration with the given AdminLogChecks.
@NotNull AdminConfigurationResult	validateServerConfiguration(@NotNull ServerConfigServer configuration, @NotNull List<AdminServerCheck> checks)	Validates the ServerConfigServer configuration with the given AdminServerChecks.
protected void	validateUser()	Validates if the current user has access rights and throws ClientResultException otherwise
@NotNull AdminConfigurationResult	validateUserConfiguration(@NotNull UserConfigUsers configuration, @NotNull List<AdminUserCheck> checks)	Validates the UserConfigUsers configuration with the given AdminUserChecks.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getSession

@NotNull
public @NotNull RestSession<T_REST_DOCUMENT> getSession()

Returns the RestSession used by this AdministrationManager.

Specified by:

getSession in interface AdministrationManager<T_REST_DOCUMENT extends RestDocument>

Returns:

The RestSession used by this AdministrationManager.

validateUser

protected void validateUser()
                     throws ResultException

Validates if the current user has access rights and throws ClientResultException otherwise

Throws:

ResultException - Shall be thrown upon invalid user access.

fetchLogLength

@NotNull
public @NotNull Integer fetchLogLength(@Nullable
                                       @Nullable Date date)
                                throws ResultException

Returns the byte size of the current log or a specific log file of the server. If the date query parameter is specified, an explicitly selected log will be read.

Specified by:

fetchLogLength in interface AdministrationManager<T_REST_DOCUMENT extends RestDocument>

Parameters:

date - A specific Date to extract from the server log.

Returns:

number the length of the requested log

Throws:

ResultException - Shall be thrown, if the request failed.

fetchLogLength

@NotNull
public @NotNull Integer fetchLogLength()
                                throws ResultException

Returns the byte size of the current log file of the server.

Specified by:

fetchLogLength in interface AdministrationManager<T_REST_DOCUMENT extends RestDocument>

Returns:

number the length of the requested log

Throws:

ResultException - Shall be thrown, if the request failed.

fetchLog

@NotNull
public @NotNull String fetchLog(@NotNull
                                @NotNull String range,
                                @Nullable
                                @Nullable Date date)
                         throws ResultException

Returns the contents of the current log or a specific log file of the server. If the date query parameter is specified, an explicitly selected log will be read.

Specified by:

fetchLog in interface AdministrationManager<T_REST_DOCUMENT extends RestDocument>

Parameters:

range - A specific byte range (e.g. 0-1024) to extract from the server log

date - A specific optional Date to extract from the server log. By default, today's date will be used.

Returns:

number The contents of the current log or a specific log file of the server

Throws:

ResultException - Shall be thrown, if the request failed.

fetchLog

@NotNull
public @NotNull String fetchLog(@NotNull
                                @NotNull String range)
                         throws ResultException

Returns the contents of the current log file of the server.

Specified by:

fetchLog in interface AdministrationManager<T_REST_DOCUMENT extends RestDocument>

Parameters:

range - A specific byte range (e.g. 0-1024) to extract from the server log

Returns:

number The contents of the current log or a specific log file of the server

Throws:

ResultException - Shall be thrown, if the request failed.

fetchLog

@NotNull
public @NotNull String fetchLog()
                         throws ResultException

Returns the contents of the current log file of the server.

Specified by:

fetchLog in interface AdministrationManager<T_REST_DOCUMENT extends RestDocument>

Returns:

number The contents of the current log or a specific log file of the server

Throws:

ResultException - Shall be thrown, if the request failed.

fetchServerStatus

@NotNull
public @NotNull AdminServerStatus fetchServerStatus()
                                             throws ResultException

Provides status information about the server, the JVM and the Web services.

Specified by:

fetchServerStatus in interface AdministrationManager<T_REST_DOCUMENT extends RestDocument>

Returns:

AdminServerStatus The status information about the server.

Throws:

ResultException - Shall be thrown, if the request failed.

buildSupportPackage

public void buildSupportPackage(@NotNull
                                @NotNull OutputStream outputStream,
                                @Nullable
                                @Nullable AdminSupportEntryGroup[] group,
                                @Nullable
                                @Nullable Date start,
                                @Nullable
                                @Nullable Date end)
                         throws ResultException

Collects a set of support information, that may simplify finding the cause and solution of issues.

Specified by:

buildSupportPackage in interface AdministrationManager<T_REST_DOCUMENT extends RestDocument>

Parameters:

outputStream - The target OutputStream the support information shall be written to.

group - List of components to be included in the support information.

start - Start Date from when the logs will be included (if logs is included in group). If empty, then current date.

end - End Date until when the logs will be included (if logs is included in group). If empty, then current date.

Throws:

ResultException - Shall be thrown, if the request failed.

buildSupportPackage

public void buildSupportPackage(@NotNull
                                @NotNull OutputStream outputStream,
                                @Nullable
                                @Nullable AdminSupportEntryGroup[] group)
                         throws ResultException

Collects a set of support information, that may simplify finding the cause and solution of issues.

Specified by:

buildSupportPackage in interface AdministrationManager<T_REST_DOCUMENT extends RestDocument>

Parameters:

outputStream - The target OutputStream the support information shall be written to.

group - List of components to be included in the support information.

Throws:

ResultException - Shall be thrown, if the request failed.

buildSupportPackage

public void buildSupportPackage(@NotNull
                                @NotNull OutputStream outputStream)
                         throws ResultException

Collects a set of support information, that may simplify finding the cause and solution of issues.

Specified by:

buildSupportPackage in interface AdministrationManager<T_REST_DOCUMENT extends RestDocument>

Parameters:

outputStream - The target OutputStream the support information shall be written to.

Throws:

ResultException - Shall be thrown, if the request failed.

buildSupportPackage

public void buildSupportPackage(@NotNull
                                @NotNull File target,
                                @Nullable
                                @Nullable AdminSupportEntryGroup[] group,
                                @Nullable
                                @Nullable Date start,
                                @Nullable
                                @Nullable Date end)
                         throws ResultException

Collects a set of support information, that may simplify finding the cause and solution of issues.

Specified by:

buildSupportPackage in interface AdministrationManager<T_REST_DOCUMENT extends RestDocument>

Parameters:

target - The target File the support information shall be written to.

group - List of components to be included in the support information.

start - Start Date from when the logs will be included (if logs is included in group). If empty, then current date.

end - End Date until when the logs will be included (if logs is included in group). If empty, then current date.

Throws:

ResultException - Shall be thrown, if the request failed.

buildSupportPackage

public void buildSupportPackage(@NotNull
                                @NotNull File target,
                                @Nullable
                                @Nullable AdminSupportEntryGroup[] group)
                         throws ResultException

Collects a set of support information, that may simplify finding the cause and solution of issues.

Specified by:

buildSupportPackage in interface AdministrationManager<T_REST_DOCUMENT extends RestDocument>

Parameters:

target - The target File the support information shall be written to.

group - List of components to be included in the support information.

Throws:

ResultException - Shall be thrown, if the request failed.

buildSupportPackage

public void buildSupportPackage(@NotNull
                                @NotNull File target)
                         throws ResultException

Collects a set of support information, that may simplify finding the cause and solution of issues.

Specified by:

buildSupportPackage in interface AdministrationManager<T_REST_DOCUMENT extends RestDocument>

Parameters:

target - The target File the support information shall be written to.

Throws:

ResultException - Shall be thrown, if the request failed.

restartServer

public void restartServer()
                   throws ResultException

Restarts the server.

Specified by:

restartServer in interface AdministrationManager<T_REST_DOCUMENT extends RestDocument>

Throws:

ResultException - Shall be thrown, if the request failed.

fetchApplicationConfiguration

@NotNull
public @NotNull ApplicationConfigApplication fetchApplicationConfiguration()
                                                                    throws ResultException

Gets the ApplicationConfigApplication configuration from the server updating the cached configuration.

Specified by:

fetchApplicationConfiguration in interface AdministrationManager<T_REST_DOCUMENT extends RestDocument>

Returns:

ApplicationConfigApplication the requested configuration.

Throws:

ResultException - Shall be thrown, if the request failed.

getApplicationConfiguration

@NotNull
public @NotNull ApplicationConfigApplication getApplicationConfiguration()
                                                                  throws ResultException

Gets the cached ApplicationConfigApplication configuration of the server or fetches via AdministrationManager.fetchApplicationConfiguration() if cache is empty

Specified by:

getApplicationConfiguration in interface AdministrationManager<T_REST_DOCUMENT extends RestDocument>

Returns:

ApplicationConfigApplication the requested configuration.

Throws:

ResultException - Shall be thrown, if the request failed.

updateApplicationConfiguration

@NotNull
public @NotNull AdminConfigurationResult updateApplicationConfiguration(@NotNull
                                                                        @NotNull ApplicationConfigApplication configuration,
                                                                        @NotNull
                                                                        @NotNull List<AdminApplicationCheck> checks)
                                                                 throws ResultException

Updates the ApplicationConfigApplication configuration if no AdminConfigurationResult.getError() occured.

Optionally also validates the ApplicationConfigApplication configuration with additional AdminApplicationChecks.

Be Aware: Some of these changes might require a server restart to take effect.

Specified by:

updateApplicationConfiguration in interface AdministrationManager<T_REST_DOCUMENT extends RestDocument>

Parameters:

configuration - The ApplicationConfigApplication configuration defines settings for the web services and the portal page.

checks - A list of AdminApplicationChecks to validate the configuration.

Returns:

defines an extended AdminConfigurationResult for administrative configuration operations when the ApplicationConfigApplication configuration is updated.

Throws:

ResultException - Shall be thrown, if the request failed.

updateApplicationConfiguration

@NotNull
public @NotNull AdminConfigurationResult updateApplicationConfiguration(@NotNull
                                                                        @NotNull ApplicationConfigApplication configuration)
                                                                 throws ResultException

Updates the ApplicationConfigApplication configuration if no AdminConfigurationResult.getError() occured.

Be Aware: Some of these changes might require a server restart to take effect.

Specified by:

updateApplicationConfiguration in interface AdministrationManager<T_REST_DOCUMENT extends RestDocument>

Parameters:

configuration - The ApplicationConfigApplication configuration defines settings for the web services and the portal page.

Returns:

defines an extended AdminConfigurationResult for administrative configuration operations when the ApplicationConfigApplication configuration is updated.

Throws:

ResultException - Shall be thrown, if the request failed.

validateApplicationConfiguration

@NotNull
public @NotNull AdminConfigurationResult validateApplicationConfiguration(@NotNull
                                                                          @NotNull ApplicationConfigApplication configuration,
                                                                          @NotNull
                                                                          @NotNull List<AdminApplicationCheck> checks)
                                                                   throws ResultException

Validates the ApplicationConfigApplication configuration with the given AdminApplicationChecks.

Specified by:

validateApplicationConfiguration in interface AdministrationManager<T_REST_DOCUMENT extends RestDocument>

Parameters:

configuration - The ApplicationConfigApplication configuration defines settings for the web services and the portal page.

checks - The list of AdminApplicationChecks to validate the configuration with.

Returns:

defines an extended AdminConfigurationResult for administrative configuration operations when the ApplicationConfigApplication configuration is validated.

Throws:

ResultException - Shall be thrown, if the request failed.

fetchServerConfiguration

@NotNull
public @NotNull ServerConfigServer fetchServerConfiguration()
                                                     throws ResultException

Gets the ServerConfigServer configuration from the server updating the cached configuration.

Specified by:

fetchServerConfiguration in interface AdministrationManager<T_REST_DOCUMENT extends RestDocument>

Returns:

ServerConfigServer the requested configuration

Throws:

ResultException - Shall be thrown, if the request failed.

getServerConfiguration

@NotNull
public @NotNull ServerConfigServer getServerConfiguration()
                                                   throws ResultException

Gets the cached ServerConfigServer configuration of the server or fetches via AdministrationManager.fetchServerConfiguration() if cache is empty

Specified by:

getServerConfiguration in interface AdministrationManager<T_REST_DOCUMENT extends RestDocument>

Returns:

ServerConfigServer the requested configuration

Throws:

ResultException - Shall be thrown, if the request failed.

updateServerConfiguration

@NotNull
public @NotNull AdminConfigurationResult updateServerConfiguration(@NotNull
                                                                   @NotNull ServerConfigServer configuration,
                                                                   @NotNull
                                                                   @NotNull List<AdminServerCheck> checks)
                                                            throws ResultException

Updates the ServerConfigServer configuration if no AdminConfigurationResult.getError() occured.

Optionally also validates the ServerConfigServer configuration with additional AdminServerChecks.

Be Aware: Some of these changes might require a server restart to take effect.

Specified by:

updateServerConfiguration in interface AdministrationManager<T_REST_DOCUMENT extends RestDocument>

Parameters:

configuration - The ServerConfigServer configuration defines settings for the server such as the ports, user sources or authorization settings.

checks - A list of AdminServerChecks to validate the configuration

Returns:

defines an extended AdminConfigurationResult for administrative configuration operations when the ServerConfigServer configuration is updated.

Throws:

ResultException - Shall be thrown, if the request failed.

updateServerConfiguration

@NotNull
public @NotNull AdminConfigurationResult updateServerConfiguration(@NotNull
                                                                   @NotNull ServerConfigServer configuration)
                                                            throws ResultException

Updates the ServerConfigServer configuration if no AdminConfigurationResult.getError() occured.

Be Aware: Some of these changes might require a server restart to take effect.

Specified by:

updateServerConfiguration in interface AdministrationManager<T_REST_DOCUMENT extends RestDocument>

Parameters:

configuration - The ServerConfigServer configuration defines settings for the server such as the ports, user sources or authorization settings.

Returns:

defines an extended AdminConfigurationResult for administrative configuration operations when the ServerConfigServer configuration is updated.

Throws:

ResultException - Shall be thrown, if the request failed.

validateServerConfiguration

@NotNull
public @NotNull AdminConfigurationResult validateServerConfiguration(@NotNull
                                                                     @NotNull ServerConfigServer configuration,
                                                                     @NotNull
                                                                     @NotNull List<AdminServerCheck> checks)
                                                              throws ResultException

Validates the ServerConfigServer configuration with the given AdminServerChecks.

Specified by:

validateServerConfiguration in interface AdministrationManager<T_REST_DOCUMENT extends RestDocument>

Parameters:

configuration - The ServerConfigServer configuration defines settings for the web services and the portal page.

checks - The list of AdminServerChecks to validate the configuration with.

Returns:

defines an extended AdminConfigurationResult for administrative configuration operations when the ServerConfigServer configuration is validated.

Throws:

ResultException - Shall be thrown, if the request failed.

fetchUserConfiguration

@NotNull
public @NotNull UserConfigUsers fetchUserConfiguration()
                                                throws ResultException

Gets the UserConfigUsers configuration of the server updating the cached configuration.

Specified by:

fetchUserConfiguration in interface AdministrationManager<T_REST_DOCUMENT extends RestDocument>

Returns:

UserConfigUsers the requested configuration

Throws:

ResultException - Shall be thrown, if the request failed.

getUserConfiguration

@NotNull
public @NotNull UserConfigUsers getUserConfiguration()
                                              throws ResultException

Gets the cached UserConfigUsers configuration of the server or fetches via AdministrationManager.fetchUserConfiguration() if cache is empty

Specified by:

getUserConfiguration in interface AdministrationManager<T_REST_DOCUMENT extends RestDocument>

Returns:

UserConfigUsers the requested configuration

Throws:

ResultException - Shall be thrown, if the request failed.

updateUserConfiguration

@NotNull
public @NotNull AdminConfigurationResult updateUserConfiguration(@NotNull
                                                                 @NotNull UserConfigUsers configuration,
                                                                 @NotNull
                                                                 @NotNull List<AdminUserCheck> checks)
                                                          throws ResultException

Updates the UserConfigUsers configuration if no AdminConfigurationResult.getError() occured.

Optionally also validates the UserConfigUsers configuration with additional AdminUserChecks.

Be Aware: Some of these changes might require a server restart to take effect.

Specified by:

updateUserConfiguration in interface AdministrationManager<T_REST_DOCUMENT extends RestDocument>

Parameters:

configuration - The UserConfigUsers configuration lists users of the webPDF server.

checks - A list of AdminUserChecks to validate the configuration

Returns:

defines an extended AdminConfigurationResult for administrative configuration operations when the UserConfigUsers configuration is updated.

Throws:

ResultException - Shall be thrown, if the request failed.

updateUserConfiguration

@NotNull
public @NotNull AdminConfigurationResult updateUserConfiguration(@NotNull
                                                                 @NotNull UserConfigUsers configuration)
                                                          throws ResultException

Updates the UserConfigUsers configuration if no AdminConfigurationResult.getError() occured.

Be Aware: Some of these changes might require a server restart to take effect.

Specified by:

updateUserConfiguration in interface AdministrationManager<T_REST_DOCUMENT extends RestDocument>

Parameters:

configuration - The UserConfigUsers configuration lists users of the webPDF server.

Returns:

defines an extended AdminConfigurationResult for administrative configuration operations when the UserConfigUsers configuration is updated.

Throws:

ResultException - Shall be thrown, if the request failed.

validateUserConfiguration

@NotNull
public @NotNull AdminConfigurationResult validateUserConfiguration(@NotNull
                                                                   @NotNull UserConfigUsers configuration,
                                                                   @NotNull
                                                                   @NotNull List<AdminUserCheck> checks)
                                                            throws ResultException

Validates the UserConfigUsers configuration with the given AdminUserChecks.

Specified by:

validateUserConfiguration in interface AdministrationManager<T_REST_DOCUMENT extends RestDocument>

Parameters:

configuration - The UserConfigUsers configuration defines settings for the web services and the portal page.

checks - The list of AdminUserChecks to validate the configuration with.

Returns:

defines an extended AdminConfigurationResult for administrative configuration operations when the UserConfigUsers configuration is validated.

Throws:

ResultException - Shall be thrown, if the request failed.

fetchLogConfiguration

@NotNull
public @NotNull AdminLogFileConfiguration fetchLogConfiguration()
                                                         throws ResultException

Gets the AdminLogFileConfiguration from the server updating the cached configuration.

Specified by:

fetchLogConfiguration in interface AdministrationManager<T_REST_DOCUMENT extends RestDocument>

Returns:

AdminLogFileConfiguration the requested configuration

Throws:

ResultException - Shall be thrown, if the request failed.

getLogConfiguration

@NotNull
public @NotNull AdminLogFileConfiguration getLogConfiguration()
                                                       throws ResultException

Gets the cached AdminLogFileConfiguration configuration of the server or fetches via AdministrationManager.fetchLogConfiguration() if cache is empty

Specified by:

getLogConfiguration in interface AdministrationManager<T_REST_DOCUMENT extends RestDocument>

Returns:

AdminLogFileConfiguration the requested configuration

Throws:

ResultException - Shall be thrown, if the request failed.

updateLogConfiguration

@NotNull
public @NotNull AdminConfigurationResult updateLogConfiguration(@NotNull
                                                                @NotNull AdminLogFileConfiguration configuration,
                                                                @NotNull
                                                                @NotNull List<AdminLogCheck> checks)
                                                         throws ResultException

Updates the AdminLogFileConfiguration if no AdminConfigurationResult.getError() occured.

Optionally also validates the AdminLogFileConfiguration with additional AdminLogChecks.

Be Aware: Some of these changes might require a server restart to take effect.

Specified by:

updateLogConfiguration in interface AdministrationManager<T_REST_DOCUMENT extends RestDocument>

Parameters:

configuration - The AdminLogFileConfiguration provides information and settings about the configured server logging.

checks - A list of AdminLogChecks to validate the configuration

Returns:

defines an extended AdminConfigurationResult for administrative configuration operations when the AdminLogFileConfiguration is updated.

Throws:

ResultException - Shall be thrown, if the request failed.

updateLogConfiguration

@NotNull
public @NotNull AdminConfigurationResult updateLogConfiguration(@NotNull
                                                                @NotNull AdminLogFileConfiguration configuration)
                                                         throws ResultException

Updates the AdminLogFileConfiguration if no AdminConfigurationResult.getError() occured.

Be Aware: Some of these changes might require a server restart to take effect.

Specified by:

updateLogConfiguration in interface AdministrationManager<T_REST_DOCUMENT extends RestDocument>

Parameters:

configuration - The AdminLogFileConfiguration provides information and settings about the configured server logging.

Returns:

defines an extended AdminConfigurationResult for administrative configuration operations when the AdminLogFileConfiguration is updated.

Throws:

ResultException - Shall be thrown, if the request failed.

validateLogConfiguration

@NotNull
public @NotNull AdminConfigurationResult validateLogConfiguration(@NotNull
                                                                  @NotNull AdminLogFileConfiguration configuration,
                                                                  @NotNull
                                                                  @NotNull List<AdminLogCheck> checks)
                                                           throws ResultException

Validates the AdminLogFileConfiguration configuration with the given AdminLogChecks.

Specified by:

validateLogConfiguration in interface AdministrationManager<T_REST_DOCUMENT extends RestDocument>

Parameters:

configuration - The AdminLogFileConfiguration configuration defines settings for the web services and the portal page.

checks - The list of AdminLogChecks to validate the configuration with.

Returns:

defines an extended AdminConfigurationResult for administrative configuration operations when the AdminLogFileConfiguration configuration is validated.

Throws:

ResultException - Shall be thrown, if the request failed.

fetchGlobalKeyStore

@NotNull
public @NotNull AdminGlobalKeyStore fetchGlobalKeyStore()
                                                 throws ResultException

Gets the AdminGlobalKeyStore of the server updating the cached keystore.

Specified by:

fetchGlobalKeyStore in interface AdministrationManager<T_REST_DOCUMENT extends RestDocument>

Returns:

AdminGlobalKeyStore the requested keystore

Throws:

ResultException - Shall be thrown, if the request failed.

getGlobalKeyStore

@NotNull
public @NotNull AdminGlobalKeyStore getGlobalKeyStore()
                                               throws ResultException

Gets the cached AdminGlobalKeyStore of the server or fetches via AdministrationManager.fetchGlobalKeyStore() if cache is empty

Specified by:

getGlobalKeyStore in interface AdministrationManager<T_REST_DOCUMENT extends RestDocument>

Returns:

AdminGlobalKeyStore the requested keystore

Throws:

ResultException - Shall be thrown, if the request failed.

setGlobalKeyStore

public void setGlobalKeyStore(@NotNull
                              @NotNull AdminGlobalKeyStore keystore)

Sets the AdminGlobalKeyStore of the server.

Be Aware: This needs to be updated via AdministrationManager.updateApplicationConfiguration(net.webpdf.wsclient.openapi.ApplicationConfigApplication, java.util.List<net.webpdf.wsclient.openapi.AdminApplicationCheck>) to take effekt on the server.

Specified by:

setGlobalKeyStore in interface AdministrationManager<T_REST_DOCUMENT extends RestDocument>

Parameters:

keystore - the AdminGlobalKeyStore to set

fetchTrustStoreKeyStore

@NotNull
public @NotNull AdminTrustStoreKeyStore fetchTrustStoreKeyStore()
                                                         throws ResultException

Gets the AdminTrustStoreKeyStore from the server updating the cached keystore.

Specified by:

fetchTrustStoreKeyStore in interface AdministrationManager<T_REST_DOCUMENT extends RestDocument>

Returns:

AdminTrustStoreKeyStore the requested keystore

Throws:

ResultException - Shall be thrown, if the request failed.

getTrustStoreKeyStore

@NotNull
public @NotNull AdminTrustStoreKeyStore getTrustStoreKeyStore()
                                                       throws ResultException

Gets the cached AdminTrustStoreKeyStore configuration of the server or fetches via AdministrationManager.fetchTrustStoreKeyStore() if cache is empty

Specified by:

getTrustStoreKeyStore in interface AdministrationManager<T_REST_DOCUMENT extends RestDocument>

Returns:

AdminTrustStoreKeyStore the requested keystore

Throws:

ResultException - Shall be thrown, if the request failed.

setTrustStoreKeyStore

public void setTrustStoreKeyStore(@NotNull
                                  @NotNull AdminTrustStoreKeyStore keystore)

Sets the AdminTrustStoreKeyStore of the server.

Be Aware: This needs to be updated via AdministrationManager.updateServerConfiguration(net.webpdf.wsclient.openapi.ServerConfigServer, java.util.List<net.webpdf.wsclient.openapi.AdminServerCheck>) to take effekt on the server.

Specified by:

setTrustStoreKeyStore in interface AdministrationManager<T_REST_DOCUMENT extends RestDocument>

Parameters:

keystore - the AdminTrustStoreKeyStore to set

fetchConnectorKeyStore

@NotNull
public @NotNull Map<String,AdminConnectorKeyStore> fetchConnectorKeyStore()
                                                                         throws ResultException

Gets the from the server updating the cached keystore.

Specified by:

fetchConnectorKeyStore in interface AdministrationManager<T_REST_DOCUMENT extends RestDocument>

Returns:

AdminConnectorKeyStore the requested keystore

Throws:

ResultException - Shall be thrown, if the request failed.

getConnectorKeyStore

@NotNull
public @NotNull Map<String,AdminConnectorKeyStore> getConnectorKeyStore()
                                                                       throws ResultException

Gets the cached AdminConnectorKeyStores of the server or fetches via AdministrationManager.fetchConnectorKeyStore() if cache is empty

Specified by:

getConnectorKeyStore in interface AdministrationManager<T_REST_DOCUMENT extends RestDocument>

Returns:

AdminConnectorKeyStores the requested keystore

Throws:

ResultException - Shall be thrown, if the request failed.

setConnectorKeyStore

public void setConnectorKeyStore(@NotNull
                                 @NotNull Map<String,AdminConnectorKeyStore> keystore)

Sets the AdminConnectorKeyStore of the server.

Be Aware: This needs to be updated via AdministrationManager.updateServerConfiguration(net.webpdf.wsclient.openapi.ServerConfigServer, java.util.List<net.webpdf.wsclient.openapi.AdminServerCheck>) to take effekt on the server.

Specified by:

setConnectorKeyStore in interface AdministrationManager<T_REST_DOCUMENT extends RestDocument>

Parameters:

keystore - the AdminConnectorKeyStore to set

testExecutables

@NotNull
public @NotNull AdminConfigurationResult testExecutables(@NotNull
                                                         @NotNull ApplicationConfigApplication configuration,
                                                         @NotNull
                                                         @NotNull List<AdminExecutableName> executables)
                                                  throws ResultException

This is a shortcut function to validate ApplicationConfigApplication configuration executables

Specified by:

testExecutables in interface AdministrationManager<T_REST_DOCUMENT extends RestDocument>

Parameters:

configuration - The ApplicationConfigApplication configuration defines settings for the web services and the portal page.

executables - A list of AdminExecutableNames to validate

Returns:

defines an extended AdminConfigurationResult for administrative configuration operations when the ApplicationConfigApplication configuration validated.

Throws:

ResultException - Shall be thrown, if the request failed.

fetchDatastore

public AdminFileDataStore fetchDatastore(@NotNull
                                         @NotNull AdminFileGroupDataStore group,
                                         @Nullable
                                         @Nullable String filename)
                                  throws ResultException

Retrieves a file, depending on the selected AdminFileGroupDataStore, from the server's data store. If AdminFileGroupDataStore.GENERIC is set, the file to get is referenced by the optional filename parameter.

Specified by:

fetchDatastore in interface AdministrationManager<T_REST_DOCUMENT extends RestDocument>

Parameters:

group - The group of datastore files to search for the file.

filename - A filename to specify the file if AdminFileGroupDataStore.GENERIC is set

Returns:

The requested AdminFileDataStore.

Throws:

ResultException - Shall be thrown, if the request failed.

fetchDatastore

public AdminFileDataStore fetchDatastore(@NotNull
                                         @NotNull AdminFileGroupDataStore group)
                                  throws ResultException

Retrieves a file, depending on the selected AdminFileGroupDataStore, from the server's data store. If AdminFileGroupDataStore.GENERIC is set, the file to get is referenced by the optional filename parameter.

Specified by:

fetchDatastore in interface AdministrationManager<T_REST_DOCUMENT extends RestDocument>

Parameters:

group - The group of datastore files to search for the file.

Returns:

The requested AdminFileDataStore.

Throws:

ResultException - Shall be thrown, if the request failed.

updateDatastore

public void updateDatastore(@NotNull
                            @NotNull AdminFileDataStore fileDataStore)
                     throws ResultException

Updates a file in the server's data store.

Specified by:

updateDatastore in interface AdministrationManager<T_REST_DOCUMENT extends RestDocument>

Parameters:

fileDataStore - Bundles the file, the file group and the settings to be updated as AdminFileDataStore

Throws:

ResultException - Shall be thrown, if the request failed.

deleteDatastore

public void deleteDatastore(@NotNull
                            @NotNull AdminFileGroupDataStore group,
                            @Nullable
                            @Nullable String filename)
                     throws ResultException

Deletes a file, depending on the selected AdminFileGroupDataStore, from the server's data store. If AdminFileGroupDataStore.GENERIC is set, the file to delete is referenced by the optional filename parameter.

Specified by:

deleteDatastore in interface AdministrationManager<T_REST_DOCUMENT extends RestDocument>

Parameters:

group - The group of datastore files to search for the file.

filename - A filename to specify the file if AdminFileGroupDataStore.GENERIC is set

Throws:

ResultException - Shall be thrown, if the request failed.

deleteDatastore

public void deleteDatastore(@NotNull
                            @NotNull AdminFileGroupDataStore group)
                     throws ResultException

Deletes a file, depending on the selected AdminFileGroupDataStore, from the server's data store.

Specified by:

deleteDatastore in interface AdministrationManager<T_REST_DOCUMENT extends RestDocument>

Parameters:

group - The group of datastore files to search for the file.

Throws:

ResultException - Shall be thrown, if the request failed.

fetchServerStatistic

@NotNull
public @NotNull AdminStatistic fetchServerStatistic(@NotNull
                                                    @NotNull AdminDataSourceServerState dataSource,
                                                    @NotNull
                                                    @NotNull AdminAggregationServerState aggregation,
                                                    @NotNull
                                                    @NotNull List<Webservice> webservices,
                                                    @NotNull
                                                    @NotNull Date start,
                                                    @NotNull
                                                    @NotNull Date end)
                                             throws ResultException

(Experimental Web service)

Reads statistic information from the server for Web services and file formats.

Specified by:

fetchServerStatistic in interface AdministrationManager<T_REST_DOCUMENT extends RestDocument>

Parameters:

dataSource - Data source from which the data is read.

aggregation - Aggregation mode for the retrieved data.

webservices - List of webservice names from which the data should be retrieved.

start - Start Date for the data, formatted as ISO-8601 extended offset (zoned based) date-time format.

end - End Date for the data, formatted as ISO-8601 extended offset (zoned based) date-time format.

Returns:

The requested AdminStatistic.

Throws:

ResultException - Shall be thrown, if the request failed.

fetchSessionTable

@NotNull
public @NotNull SessionTable fetchSessionTable()
                                        throws ResultException

Returns the session table from server with detailed status information about each session.

Specified by:

fetchSessionTable in interface AdministrationManager<T_REST_DOCUMENT extends RestDocument>

Returns:

The requested SessionTable.

Throws:

ResultException - Shall be thrown, if the request failed.

closeSession

public void closeSession(@NotNull
                         @NotNull String sessionId)
                  throws ResultException

Closes the session with the specified ID, by activating the session expiration. After the call, any access to the session results in an error.

Specified by:

closeSession in interface AdministrationManager<T_REST_DOCUMENT extends RestDocument>

Parameters:

sessionId - ID of the session to be closed.

Throws:

ResultException - Shall be thrown, if the request failed.