io.fabric8.security.sso.client

Class OpenAMRestClient

java.lang.Object

io.fabric8.security.sso.client.OpenAMRestClient

public class OpenAMRestClient
extends java.lang.Object

Simple helper class that makes it easy to invoke on OpenAM's REST interface

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	debug
protected java.lang.String	OpenAMHostName
protected java.lang.String	OpenAMMethod
protected java.lang.String	OpenAMPort
protected java.lang.String	OpenAMRealm
protected java.lang.String	OpenAMService
protected java.lang.String	OpenAMURLPrefix
protected java.lang.String	ServicePrefix

Constructor Summary

Constructors

Constructor and Description
OpenAMRestClient()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	authenticate(java.lang.String username, java.lang.String password) Authenticates the supplied username and password and returns a token from the security token service
boolean	authorize(java.lang.String service, java.lang.String token) Checks to see if the supplied token is authorized to access the supplied service using GET
boolean	authorize(java.lang.String service, java.lang.String token, java.lang.String action) Checks to see if the supplied token is authorized to access the supplied service using the supplied action (GET or POST)
protected boolean	checkResult(java.lang.String result)
protected java.lang.String	doInvoke(java.lang.String url)
protected java.lang.String	getAuthenticateUrl(java.lang.String username, java.lang.String password)
protected java.lang.String	getAuthorizeUrl(java.lang.String uri, java.lang.String token, java.lang.String action)
protected java.lang.String	getIsValidTokenUrl(java.lang.String token)
protected java.lang.String	getLogoutUrl(java.lang.String token)
java.lang.String	getOpenAMHostName()
java.lang.String	getOpenAMMethod()
java.lang.String	getOpenAMPort()
java.lang.String	getOpenAMRealm()
java.lang.String	getOpenAMService()
java.lang.String	getOpenAMURLPrefix()
java.lang.String	getServicePrefix()
java.lang.String	getURLPrefix() Returns the base URL of the OpenAM server this client instance will invoke on
boolean	isDebug()
boolean	isValidToken(java.lang.String token) Checks with the security token service to see if the supplied token is a valid token
void	logout(java.lang.String token)
protected java.lang.String	read(java.io.InputStream is)
void	setDebug(boolean debug)
void	setOpenAMHostName(java.lang.String openAMHostName)
void	setOpenAMMethod(java.lang.String openAMMethod)
void	setOpenAMPort(java.lang.String openAMPort)
void	setOpenAMRealm(java.lang.String openAMRealm)
void	setOpenAMService(java.lang.String openAMService)
void	setOpenAMURLPrefix(java.lang.String openAMURLPrefix)
void	setServicePrefix(java.lang.String servicePrefix)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

OpenAMRealm

protected java.lang.String OpenAMRealm

OpenAMService

protected java.lang.String OpenAMService

OpenAMHostName

protected java.lang.String OpenAMHostName

OpenAMPort

protected java.lang.String OpenAMPort

OpenAMMethod

protected java.lang.String OpenAMMethod

OpenAMURLPrefix

protected java.lang.String OpenAMURLPrefix

ServicePrefix

protected java.lang.String ServicePrefix

debug

protected boolean debug

Constructor Detail

OpenAMRestClient

public OpenAMRestClient()

Method Detail

authenticate

public java.lang.String authenticate(java.lang.String username,
                            java.lang.String password)

Authenticates the supplied username and password and returns a token from the security token service

Parameters:

username -

password -

Returns:

authorize

public boolean authorize(java.lang.String service,
                java.lang.String token,
                java.lang.String action)

Checks to see if the supplied token is authorized to access the supplied service using the supplied action (GET or POST)

Parameters:

service - The service the token will be authorized against, will be concatenated onto the ServicePrefix property

token - The security token

action - either GET or POST

Returns:

authorize

public boolean authorize(java.lang.String service,
                java.lang.String token)

Checks to see if the supplied token is authorized to access the supplied service using GET

Parameters:

service - The service the token will be authorized against, will be concatenated onto the ServicePrefix property

token - the security token obtained from a previous call to @authenticate

Returns:

isValidToken

public boolean isValidToken(java.lang.String token)

Checks with the security token service to see if the supplied token is a valid token

Parameters:

token -

Returns:

getURLPrefix

public java.lang.String getURLPrefix()

Returns the base URL of the OpenAM server this client instance will invoke on

Returns:

logout

public void logout(java.lang.String token)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

checkResult

protected boolean checkResult(java.lang.String result)

read

protected java.lang.String read(java.io.InputStream is)
                         throws java.io.IOException

Throws:

java.io.IOException

doInvoke

protected java.lang.String doInvoke(java.lang.String url)

getLogoutUrl

protected java.lang.String getLogoutUrl(java.lang.String token)

getIsValidTokenUrl

protected java.lang.String getIsValidTokenUrl(java.lang.String token)

getAuthorizeUrl

protected java.lang.String getAuthorizeUrl(java.lang.String uri,
                               java.lang.String token,
                               java.lang.String action)

getAuthenticateUrl

protected java.lang.String getAuthenticateUrl(java.lang.String username,
                                  java.lang.String password)

getOpenAMRealm

public java.lang.String getOpenAMRealm()

setOpenAMRealm

public void setOpenAMRealm(java.lang.String openAMRealm)

getOpenAMService

public java.lang.String getOpenAMService()

setOpenAMService

public void setOpenAMService(java.lang.String openAMService)

getOpenAMHostName

public java.lang.String getOpenAMHostName()

setOpenAMHostName

public void setOpenAMHostName(java.lang.String openAMHostName)

getOpenAMPort

public java.lang.String getOpenAMPort()

setOpenAMPort

public void setOpenAMPort(java.lang.String openAMPort)

getOpenAMMethod

public java.lang.String getOpenAMMethod()

setOpenAMMethod

public void setOpenAMMethod(java.lang.String openAMMethod)

getOpenAMURLPrefix

public java.lang.String getOpenAMURLPrefix()

setOpenAMURLPrefix

public void setOpenAMURLPrefix(java.lang.String openAMURLPrefix)

getServicePrefix

public java.lang.String getServicePrefix()

setServicePrefix

public void setServicePrefix(java.lang.String servicePrefix)

isDebug

public boolean isDebug()

setDebug

public void setDebug(boolean debug)