Package | Description |
---|---|
com.gentics.contentnode.rest.client | |
com.gentics.contentnode.rest.client.exceptions |
Modifier and Type | Method and Description |
---|---|
void |
RestClient.assertMatchingVersion()
Checks if the version of the REST API on the server is the same that is used
by the client; if there is a mismatch between the two versions, a RestException is thrown
|
void |
RestClient.assertResponse(GenericResponse response)
Analyzes the response of a finished request and asserts that it was executed without errors;
if a problem occurred during the request, a specialized RestException is thrown
|
User |
RestClient.authenticate(String sid,
String sessionSecret)
Authenticate with given sid and session secret
|
javax.ws.rs.client.WebTarget |
RestClient.base()
Provides access to the WebTarget that is used as the base for all commands to the server
|
List<org.apache.http.cookie.Cookie> |
RestClient.getCookies()
Get the cookies currently stored in the client
|
void |
RestClient.login(String username,
String password)
Logs the specified user into the system using the password given
|
void |
RestClient.logout()
Logs out the current user
|
void |
RestClient.ssologin()
Performs login on an SSO system - before this works,
necessary filters have to be defined
|
Modifier and Type | Class and Description |
---|---|
class |
AuthRequiredRestException
Exception that is thrown when the session identification is missing or invalid
|
class |
FailureRestException
Exception that is thrown when an unexpected error has occurred (example: a database error prevented saving)
|
class |
InvalidDataRestException
Exception that is thrown when data for the request was invalid or insufficient
|
class |
MaintenanceModeRestException
Exception that is thrown when it is not possible to send requests to a system because it is currently in maintenance mode
|
class |
NotFoundRestException
Exception that is thrown when a requested object was not found in the system
|
class |
PermissionRestException
Exception that is thrown when the user did not have sufficient permissions to carry out the action
|
Copyright © 2024 Gentics Software. All rights reserved.