|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.jalios.rest.client.authentication.AuthKeyAuthentication
public class AuthKeyAuthentication
JCMS Open API Authentication using authentication key. Many such authentication may been added to a single ClientSession. To use it in prefix mode, the constructor with three arguments has to be used.
Constructor Summary | |
---|---|
AuthKeyAuthentication(org.restlet.data.Reference ref)
OpenAPI Authentication based on authentication key for a single url. |
|
AuthKeyAuthentication(String url)
OpenAPI Authentication based on authentication key for a single url. |
|
AuthKeyAuthentication(String url,
String authKey)
OpenAPI Authentication based on authentication key for a single url. |
|
AuthKeyAuthentication(String url,
String authKey,
boolean prefix)
OpenAPI Authentication based on authentication key for a single url. |
Method Summary | |
---|---|
void |
addAuthentication(org.restlet.data.Request request)
|
static org.restlet.data.Reference |
getReferenceUriWithAuthKey(String url,
String authKey)
|
static org.restlet.data.Reference |
getReferenceWithAuthKey(org.restlet.data.Reference reference,
String authKey)
|
boolean |
isDeprecated()
A authentication may be available for a few time. |
static boolean |
removeAuthKey(org.restlet.data.Reference reference)
|
org.restlet.data.Response |
updateAuthenticationResult(ClientSession session,
org.restlet.data.Request request,
org.restlet.data.Response response)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public AuthKeyAuthentication(String url, String authKey)
url
- authKey
- public AuthKeyAuthentication(String url, String authKey, boolean prefix)
url
- authKey
- prefix
- if true, the url is considered as a prefix of url for wich the authKey is supposed to be good.public AuthKeyAuthentication(String url)
url
- it included the authKey parameterpublic AuthKeyAuthentication(org.restlet.data.Reference ref)
ref
- it included the authKey parameterMethod Detail |
---|
public void addAuthentication(org.restlet.data.Request request)
addAuthentication
in interface Authentication
public org.restlet.data.Response updateAuthenticationResult(ClientSession session, org.restlet.data.Request request, org.restlet.data.Response response)
updateAuthenticationResult
in interface Authentication
public static org.restlet.data.Reference getReferenceUriWithAuthKey(String url, String authKey)
public static org.restlet.data.Reference getReferenceWithAuthKey(org.restlet.data.Reference reference, String authKey)
public static boolean removeAuthKey(org.restlet.data.Reference reference)
public boolean isDeprecated()
Authentication
isDeprecated
in interface Authentication
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |