org.apache.syncope.core.rest.cxf.service

Class SAML2SPServiceImpl

java.lang.Object

org.apache.syncope.core.rest.cxf.service.SAML2SPServiceImpl

All Implemented Interfaces:

JAXRSService, SAML2SPService

@Service
public class SAML2SPServiceImpl
extends Object
implements SAML2SPService

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.slf4j.Logger	LOG
protected org.apache.cxf.jaxrs.ext.MessageContext	messageContext
protected static String	OPTIONS_ALLOW
protected SearchCondVisitor	searchCondVisitor
protected org.apache.cxf.jaxrs.ext.search.SearchContext	searchContext
protected javax.ws.rs.core.UriInfo	uriInfo

Fields inherited from interface org.apache.syncope.common.rest.api.service.JAXRSService

CRLF, DOUBLE_DASH, PARAM_ANYTYPE_KIND, PARAM_ANYTYPEKEY, PARAM_CONNID_PAGED_RESULTS_COOKIE, PARAM_DETAILS, PARAM_ENTITY_KEY, PARAM_FIQL, PARAM_MAX, PARAM_NOTIFICATION, PARAM_ORDERBY, PARAM_PAGE, PARAM_REALM, PARAM_RESOURCE, PARAM_SIZE, PARAM_USER

Constructor Summary

Constructors

Constructor and Description
SAML2SPServiceImpl()

Method Summary

Modifier and Type	Method and Description
protected javax.ws.rs.core.Response.ResponseBuilder	applyPreference(ProvisioningResult<?> provisioningResult, javax.ws.rs.core.Response.ResponseBuilder builder)
protected <T extends BaseBean> PagedResult<T>	buildPagedResult(List<T> list, int page, int size, int totalCount) Builds a paged result out of a list of items and additional information.
protected void	checkETag(String etag)
SAML2RequestTO	createLoginRequest(String spEntityID, String idpEntityID) Generates SAML 2.0 authentication request for the IdP matching the provided entity ID.
SAML2RequestTO	createLogoutRequest(String spEntityID) Generates SAML 2.0 logout request for the IdP matching the requesting access token.
protected javax.ws.rs.core.Response	createResponse(ProvisioningResult<?> provisioningResult) Builds response to successful create request, taking into account any Prefer header.
protected String	getActualKey(AnyDAO<?> dao, String pretendingKey)
javax.ws.rs.core.Response	getMetadata(String spEntityID, String urlContext) Returns the XML metadata for the provided SAML 2.0 Service Provider.
protected List<OrderByClause>	getOrderByClauses(String orderBy)
protected Preference	getPreference() Reads Prefer header from request and parses into a Preference instance.
protected SearchCond	getSearchCond(String fiql, String realm)
protected boolean	isNullPriorityAsync()
protected javax.ws.rs.core.Response	modificationResponse(Object entity) Builds response to successful modification request, taking into account any Prefer header.
SAML2LoginResponseTO	validateLoginResponse(SAML2ReceivedResponseTO reponse) Validates the received SAML 2.0 authentication response and creates JWT for the matching user, if found.
void	validateLogoutResponse(SAML2ReceivedResponseTO response) Validates the received SAML 2.0 logout response.

Methods inherited from class java.lang.Object

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

Field Detail

LOG

protected static final org.slf4j.Logger LOG

OPTIONS_ALLOW

protected static final String OPTIONS_ALLOW

See Also:

Constant Field Values

uriInfo

@Context
protected javax.ws.rs.core.UriInfo uriInfo

messageContext

@Context
protected org.apache.cxf.jaxrs.ext.MessageContext messageContext

searchContext

@Context
protected org.apache.cxf.jaxrs.ext.search.SearchContext searchContext

searchCondVisitor

@Autowired
protected SearchCondVisitor searchCondVisitor

Constructor Detail

SAML2SPServiceImpl

public SAML2SPServiceImpl()

Method Detail

getMetadata

public javax.ws.rs.core.Response getMetadata(String spEntityID,
                                             String urlContext)

Description copied from interface: SAML2SPService

Returns the XML metadata for the provided SAML 2.0 Service Provider.

Specified by:

getMetadata in interface SAML2SPService

Parameters:

spEntityID - SAML 2.0 SP entity ID.

urlContext - SAML 2.0 SP agent URL context

Returns:

XML metadata for the provided SAML 2.0 Service Provider

createLoginRequest

public SAML2RequestTO createLoginRequest(String spEntityID,
                                         String idpEntityID)

Description copied from interface: SAML2SPService

Generates SAML 2.0 authentication request for the IdP matching the provided entity ID.

Specified by:

createLoginRequest in interface SAML2SPService

Parameters:

spEntityID - SAML 2.0 SP entity ID.

idpEntityID - SAML 2.0 IdP entity ID.

Returns:

SAML 2.0 authentication request

validateLoginResponse

public SAML2LoginResponseTO validateLoginResponse(SAML2ReceivedResponseTO reponse)

Description copied from interface: SAML2SPService

Validates the received SAML 2.0 authentication response and creates JWT for the matching user, if found.

Specified by:

validateLoginResponse in interface SAML2SPService

Parameters:

reponse - SAML response and relay state

Returns:

JWT for the matching user plus attributes returned in the response

createLogoutRequest

public SAML2RequestTO createLogoutRequest(String spEntityID)

Description copied from interface: SAML2SPService

Generates SAML 2.0 logout request for the IdP matching the requesting access token.

Specified by:

createLogoutRequest in interface SAML2SPService

Parameters:

spEntityID - SAML 2.0 SP entity ID.

Returns:

SAML 2.0 logout request

validateLogoutResponse

public void validateLogoutResponse(SAML2ReceivedResponseTO response)

Description copied from interface: SAML2SPService

Validates the received SAML 2.0 logout response.

Specified by:

validateLogoutResponse in interface SAML2SPService

Parameters:

response - SAML response and relay state

getActualKey

protected String getActualKey(AnyDAO<?> dao,
                              String pretendingKey)

isNullPriorityAsync

protected boolean isNullPriorityAsync()

getPreference

protected Preference getPreference()

Reads Prefer header from request and parses into a Preference instance.

Returns:

a Preference instance matching the passed Prefer header, or Preference.NONE if missing.

applyPreference

protected javax.ws.rs.core.Response.ResponseBuilder applyPreference(ProvisioningResult<?> provisioningResult,
                                                                    javax.ws.rs.core.Response.ResponseBuilder builder)

createResponse

protected javax.ws.rs.core.Response createResponse(ProvisioningResult<?> provisioningResult)

Builds response to successful create request, taking into account any Prefer header.

Parameters:

provisioningResult - the entity just created

Returns:

response to successful create request

modificationResponse

protected javax.ws.rs.core.Response modificationResponse(Object entity)

Builds response to successful modification request, taking into account any Prefer header.

Parameters:

entity - the entity just modified

Returns:

response to successful modification request

checkETag

protected void checkETag(String etag)

getSearchCond

protected SearchCond getSearchCond(String fiql,
                                   String realm)

getOrderByClauses

protected List<OrderByClause> getOrderByClauses(String orderBy)

buildPagedResult

protected <T extends BaseBean> PagedResult<T> buildPagedResult(List<T> list,
                                                               int page,
                                                               int size,
                                                               int totalCount)

Builds a paged result out of a list of items and additional information.

Type Parameters:

T - result type

Parameters:

list - bare list of items to be returned

page - current page

size - requested size

totalCount - total result size (not considering pagination)

Returns:

paged result