AbstractServiceProviderFilter (Apache CXF JavaDoc 3.0.0 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Apache CXF API

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.cxf.rs.security.saml.sso
Class AbstractServiceProviderFilter

java.lang.Object
  org.apache.cxf.rs.security.saml.sso.AbstractSSOSpHandler
      org.apache.cxf.rs.security.saml.sso.AbstractServiceProviderFilter

All Implemented Interfaces:: javax.ws.rs.container.ContainerRequestFilter

Direct Known Subclasses:: SamlPostBindingFilter, SamlRedirectBindingFilter

@PreMatching @Priority(value=1001) public abstract class AbstractServiceProviderFilter
extends AbstractSSOSpHandler
implements javax.ws.rs.container.ContainerRequestFilter
extends AbstractSSOSpHandler
implements javax.ws.rs.container.ContainerRequestFilter

Field Summary
`protected static ResourceBundle`	`BUNDLE`
`protected static Logger`	`LOG`

Constructor Summary
`AbstractServiceProviderFilter()`

Method Summary
`protected boolean`	`checkSecurityContext(Message m)`
`void`	`close()`
`protected SamlRequestInfo`	`createSamlRequestInfo(Message m)`
`protected abstract String`	`encodeAuthnRequest(Element authnRequest)`
`String`	`getIdpServiceAddress()`
`String`	`getSignatureUsername()` Get the username/alias to use to sign any request
`protected ResponseState`	`getValidResponseState(javax.ws.rs.core.Cookie securityContextCookie, Message m)`
`String`	`getWebAppDomain()`
`boolean`	`isSignRequest()`
`protected void`	`reportError(String code)`
`protected void`	`reportTrace(String code)`
`void`	`setAddEndpointAddressToContext(boolean add)`
`void`	`setAddWebAppContext(boolean addWebAppContext)`
`void`	`setAssertionConsumerServiceAddress(String assertionConsumerServiceAddress)`
`void`	`setAuthnRequestBuilder(AuthnRequestBuilder authnRequestBuilder)`
`void`	`setIdpServiceAddress(String idpServiceAddress)`
`void`	`setIssuerId(String issuerId)`
`protected void`	`setSecurityContext(Message m, org.apache.wss4j.common.saml.SamlAssertionWrapper assertionWrapper)`
`void`	`setSignatureUsername(String signatureUsername)` Set the username/alias to use to sign any request
`void`	`setSignRequest(boolean signRequest)`
`void`	`setWebAppDomain(String webAppDomain)`
`protected abstract void`	`signAuthnRequest(org.opensaml.saml2.core.AuthnRequest authnRequest)`

Methods inherited from class org.apache.cxf.rs.security.saml.sso.AbstractSSOSpHandler
`createCookie, getCallbackHandler, getProps, getSignatureCrypto, getStateProvider, getStateTimeToLive, isStateExpired, setCallbackHandler, setCallbackHandlerClass, setSignatureCrypto, setSignaturePropertiesFile, setStateProvider, setStateTimeToLive`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Methods inherited from interface javax.ws.rs.container.ContainerRequestFilter
`filter`

Field Detail

LOG

protected static final Logger LOG

BUNDLE

protected static final ResourceBundle BUNDLE

Constructor Detail

AbstractServiceProviderFilter

public AbstractServiceProviderFilter()

Method Detail

setAddEndpointAddressToContext

public void setAddEndpointAddressToContext(boolean add)

setSignRequest

public void setSignRequest(boolean signRequest)

isSignRequest

public boolean isSignRequest()

setAuthnRequestBuilder

public void setAuthnRequestBuilder(AuthnRequestBuilder authnRequestBuilder)

setAssertionConsumerServiceAddress

public void setAssertionConsumerServiceAddress(String assertionConsumerServiceAddress)

setIssuerId

public void setIssuerId(String issuerId)

setIdpServiceAddress

public void setIdpServiceAddress(String idpServiceAddress)

getIdpServiceAddress

public String getIdpServiceAddress()

setSignatureUsername

public void setSignatureUsername(String signatureUsername)

Set the username/alias to use to sign any request

Parameters:: signatureUsername - the username/alias to use to sign any request

getSignatureUsername

public String getSignatureUsername()

Get the username/alias to use to sign any request

Returns:: the username/alias to use to sign any request

close

@PreDestroy
public void close()

Overrides:: close in class AbstractSSOSpHandler

checkSecurityContext

protected boolean checkSecurityContext(Message m)

setSecurityContext

protected void setSecurityContext(Message m,
                                  org.apache.wss4j.common.saml.SamlAssertionWrapper assertionWrapper)

getValidResponseState

protected ResponseState getValidResponseState(javax.ws.rs.core.Cookie securityContextCookie,
                                              Message m)

createSamlRequestInfo

protected SamlRequestInfo createSamlRequestInfo(Message m)
                                         throws Exception

Throws:: Exception

encodeAuthnRequest

protected abstract String encodeAuthnRequest(Element authnRequest)
                                      throws IOException

Throws:: IOException

signAuthnRequest

protected abstract void signAuthnRequest(org.opensaml.saml2.core.AuthnRequest authnRequest)
                                  throws Exception

Throws:: Exception

reportError

protected void reportError(String code)

reportTrace

protected void reportTrace(String code)

getWebAppDomain

public String getWebAppDomain()

setWebAppDomain

public void setWebAppDomain(String webAppDomain)

setAddWebAppContext

public void setAddWebAppContext(boolean addWebAppContext)