Package io.goobi.viewer.model.security.authentication

Class HttpAuthenticationProvider

java.lang.Object

io.goobi.viewer.model.security.authentication.HttpAuthenticationProvider

All Implemented Interfaces:

IAuthenticationProvider

Direct Known Subclasses:

BibliothecaProvider, HttpHeaderProvider, LitteraProvider, OpenIdProvider, VuFindProvider

public abstract class HttpAuthenticationProvider
extends Object
implements IAuthenticationProvider

Abstract HttpAuthenticationProvider class.

Author:

Florian Alpers

Field Summary

Fields

Modifier and Type	Field	Description
protected List<String>	addUserToGroups
protected static org.apache.http.impl.conn.PoolingHttpClientConnectionManager	connectionManager	Constant connectionManager
protected static final String	DEFAULT_EMAIL	Constant DEFAULT_EMAIL="{username}@nomail.com"
protected final String	image
protected final String	label
protected final String	name
protected String	redirectUrl	URL to redirect to after successful login.
protected final long	timeoutMillis
protected final String	type
protected static final String	TYPE_USER_PASSWORD	Constant TYPE_USER_PASSWORD="userPassword"
protected String	url

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	HttpAuthenticationProvider(String name, String label, String type, String url, String image, long timeoutMillis)	Constructor for HttpAuthenticationProvider.

Method Summary

Modifier and Type	Method	Description
protected String	get(URI url)	get.
List<String>	getAddUserToGroups()	getAddUserToGroups.
String	getImage()	Getter for the field image.
String	getImageUrl()	getImageUrl.
String	getLabel()	Getter for the field label.
String	getName()	Returns an unique name for the authentication provider implementation
String	getRedirectUrl()
long	getTimeoutMillis()	Getter for the field timeoutMillis.
String	getType()	The provider type.
String	getUrl()	Getter for the field url.
protected String	post(URI url, String requestEntity)	post.
void	setAddUserToGroups(List<String> addUserToGroups)	setAddUserToGroups.
void	setRedirectUrl(String redirectUrl)

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.goobi.viewer.model.security.authentication.IAuthenticationProvider

allowsEmailChange, allowsNicknameChange, allowsPasswordChange, login, logout

Field Details

DEFAULT_EMAIL

protected static final String DEFAULT_EMAIL

Constant DEFAULT_EMAIL="{username}@nomail.com"

See Also:

• Constant Field Values

TYPE_USER_PASSWORD

protected static final String TYPE_USER_PASSWORD

Constant TYPE_USER_PASSWORD="userPassword"

See Also:

• Constant Field Values

connectionManager

protected static org.apache.http.impl.conn.PoolingHttpClientConnectionManager connectionManager

Constant connectionManager

name

protected final String name

label

protected final String label

type

protected final String type

image

protected final String image

timeoutMillis

protected final long timeoutMillis

addUserToGroups

protected List<String> addUserToGroups

url

protected String url

redirectUrl

protected String redirectUrl

URL to redirect to after successful login.

Constructor Details

HttpAuthenticationProvider

protected HttpAuthenticationProvider(String name,
 String label,
 String type,
 String url,
 String image,
 long timeoutMillis)

Constructor for HttpAuthenticationProvider.

Parameters:

name - a String object.

label - a String object.

type - a String object.

url - a String object.

image - a String object.

timeoutMillis - a long.

Method Details

getTimeoutMillis

public long getTimeoutMillis()

Getter for the field timeoutMillis.

Returns:

the timeoutMillis

getName

public String getName()

Returns an unique name for the authentication provider implementation

Specified by:

getName in interface IAuthenticationProvider

Returns:

The name of the provider

getLabel

public String getLabel()

Getter for the field label.

Returns:

the label

getUrl

public String getUrl()

Getter for the field url.

Returns:

the url

getImage

public String getImage()

Getter for the field image.

Returns:

the image

getImageUrl

public String getImageUrl()

getImageUrl.

Returns:

a String object.

getType

public String getType()

The provider type. This should either be "local", "userpassword" or "openId". This value is used to determine where this provider is displayed. Providers with the same type are displayed together

Specified by:

getType in interface IAuthenticationProvider

Returns:

The type of the provider

getAddUserToGroups

public List<String> getAddUserToGroups()

getAddUserToGroups.

Specified by:

getAddUserToGroups in interface IAuthenticationProvider

Returns:

a List object.

setAddUserToGroups

public void setAddUserToGroups(List<String> addUserToGroups)

setAddUserToGroups.

Specified by:

setAddUserToGroups in interface IAuthenticationProvider

Parameters:

addUserToGroups - a List object.

getRedirectUrl

public String getRedirectUrl()

Specified by:

getRedirectUrl in interface IAuthenticationProvider

Returns:

the redirectUrl

setRedirectUrl

public void setRedirectUrl(String redirectUrl)

Specified by:

setRedirectUrl in interface IAuthenticationProvider

Parameters:

redirectUrl - the redirectUrl to set

post

protected String post(URI url,
 String requestEntity)
               throws jakarta.ws.rs.WebApplicationException

post.

Parameters:

url - a URI object.

requestEntity - a String object.

Returns:

a String object.

Throws:

jakarta.ws.rs.WebApplicationException - if any.

get

protected String get(URI url)
              throws jakarta.ws.rs.WebApplicationException

get.

Parameters:

url - a URI object.

Returns:

a String object.

Throws:

jakarta.ws.rs.WebApplicationException - if any.