Package fr.gouv.vitam.common.client
Interface AdminClient
-
- All Superinterfaces:
java.lang.AutoCloseable
,BasicClient
,MockOrRestClient
,VitamAutoCloseable
- All Known Implementing Classes:
DefaultAdminClient
public interface AdminClient extends BasicClient
Admin basic client interface
-
-
Field Summary
-
Fields inherited from interface fr.gouv.vitam.common.client.BasicClient
STATUS_URL
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description VitamError
adminAutotest()
Check the dependencies and return a VitamError status where getHttpCode contains either 200 for OK or 503 for error and a sub list of VitamErrors for each tested subservicesAdminStatusMessage
adminStatus()
Get the administration status from the servicejava.lang.String
getAdminUrl()
-
Methods inherited from interface fr.gouv.vitam.common.client.MockOrRestClient
checkStatus, checkStatus, close, consumeAnyEntityAndClose, getResourcePath, getServiceUrl
-
-
-
-
Method Detail
-
adminStatus
AdminStatusMessage adminStatus() throws VitamClientException
Get the administration status from the service- Returns:
- the AdminStatusMessage
- Throws:
VitamClientException
- if the Server is unreachable
-
getAdminUrl
java.lang.String getAdminUrl()
- Returns:
- the adminUrl
-
adminAutotest
VitamError adminAutotest() throws VitamClientException
Check the dependencies and return a VitamError status where getHttpCode contains either 200 for OK or 503 for error and a sub list of VitamErrors for each tested subservices- Returns:
- the VitamError status, both in case of OK or ServiceUnavailable
- Throws:
VitamClientException
-
-