org.springframework.cloud.skipper.client.util

Class SecurityInfoResource

java.lang.Object

org.springframework.hateoas.RepresentationModel

org.springframework.cloud.skipper.client.util.SecurityInfoResource

public class SecurityInfoResource
extends org.springframework.hateoas.RepresentationModel

Provides security related meta-information. E.g. is security enabled, username, roles etc.

Author:

Gunnar Hillert

Constructor Summary

Constructors

Constructor and Description
SecurityInfoResource() Default constructor for serialization frameworks.

Method Summary

Modifier and Type	Method and Description
SecurityInfoResource	addRole(String role)
List<String>	getRoles() Will only contain values if isAuthorizationEnabled() is true.
String	getUsername()
boolean	isAuthenticated()
boolean	isAuthenticationEnabled()
boolean	isAuthorizationEnabled()
boolean	isFormLogin() Returns true if form-login is used.
void	setAuthenticated(boolean authenticated)
void	setAuthenticationEnabled(boolean authenticationEnabled)
void	setAuthorizationEnabled(boolean authorizationEnabled)
void	setFormLogin(boolean formLogin)
void	setRoles(List<String> roles)
void	setUsername(String username)

Methods inherited from class org.springframework.hateoas.RepresentationModel

add, add, add, addAllIf, addIf, equals, getLink, getLink, getLinks, getLinks, getLinks, getRequiredLink, getRequiredLink, hashCode, hasLink, hasLink, hasLinks, removeLinks, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SecurityInfoResource

public SecurityInfoResource()

Default constructor for serialization frameworks.

Method Detail

isAuthenticationEnabled

public boolean isAuthenticationEnabled()

Returns:

true if the authentication feature is enabled, false otherwise

setAuthenticationEnabled

public void setAuthenticationEnabled(boolean authenticationEnabled)

isAuthorizationEnabled

public boolean isAuthorizationEnabled()

Returns:

true if the authorization feature is enabled, false otherwise.

setAuthorizationEnabled

public void setAuthorizationEnabled(boolean authorizationEnabled)

isAuthenticated

public boolean isAuthenticated()

Returns:

True if the user is authenticated

setAuthenticated

public void setAuthenticated(boolean authenticated)

getUsername

public String getUsername()

Returns:

The username of the authenticated user, null otherwise.

setUsername

public void setUsername(String username)

getRoles

public List<String> getRoles()

Will only contain values if isAuthorizationEnabled() is true.

Returns:

List of Roles, if no roles are associated, an empty collection is returned.

setRoles

public void setRoles(List<String> roles)

addRole

public SecurityInfoResource addRole(String role)

Parameters:

role - Adds the role to roles

Returns:

the resource with an additional role

isFormLogin

public boolean isFormLogin()

Returns true if form-login is used. In case of OAuth2 authentication, false is returned.

Returns:

True if form-login is, false if OAuth2 authentication is used

setFormLogin

public void setFormLogin(boolean formLogin)