Package com.linecorp.armeria.server.saml

Class SamlServiceProviderBuilder

java.lang.Object

com.linecorp.armeria.server.saml.SamlServiceProviderBuilder

public final class SamlServiceProviderBuilder
extends Object

A builder which builds a SamlServiceProvider.

Method Summary

Modifier and Type	Method	Description
SamlAssertionConsumerConfigBuilder	acs()	Deprecated. Use acs(SamlEndpoint).
SamlAssertionConsumerConfigBuilder	acs(SamlEndpoint endpoint)	Returns a SamlAssertionConsumerConfigBuilder to configure a new assertion consumer service of this service provider.
SamlServiceProviderBuilder	authorizer(Authorizer<HttpRequest> authorizer)	Set an Authorizer which is used for this service provider's authentication.
SamlServiceProvider	build()	Builds a SamlServiceProvider which helps a Server have a SAML-based authentication.
SamlServiceProviderBuilder	credentialResolver(org.opensaml.security.credential.CredentialResolver credentialResolver)	Sets a CredentialResolver for this service provider.
SamlServiceProviderBuilder	encryptionKey(String encryptionKey)	Sets an encryption key name for this service provider.
SamlServiceProviderBuilder	entityId(String entityId)	Sets an entity ID for this service provider.
SamlServiceProviderBuilder	hostname(String hostname)	Sets a hostname of this service provider.
SamlIdentityProviderConfigBuilder	idp()	Returns a SamlIdentityProviderConfigBuilder to configure a new idp for authentication.
SamlServiceProviderBuilder	idpConfigSelector(SamlIdentityProviderConfigSelector idpConfigSelector)	Sets a SamlIdentityProviderConfigSelector which determines a suitable idp for a request.
SamlServiceProviderBuilder	metadataPath(String metadataPath)	Sets a URL for retrieving a metadata of this service provider.
SamlServiceProviderBuilder	port(int port)	Sets a port of this service provider.
SamlServiceProviderBuilder	requestIdManager(SamlRequestIdManager requestIdManager)	Sets a SamlRequestIdManager which creates and validates a SAML request ID.
SamlServiceProviderBuilder	scheme(SessionProtocol scheme)	Sets a protocol scheme of this service provider.
SamlServiceProviderBuilder	schemeAndPort(ServerPort serverPort)	Sets a ServerPort of this service provider.
SamlServiceProviderBuilder	signatureAlgorithm(String signatureAlgorithm)	Sets a signature algorithm which is used for signing by this service provider.
SamlServiceProviderBuilder	signingKey(String signingKey)	Sets a signing key name for this service provider.
SamlServiceProviderBuilder	sloEndpoint(SamlEndpoint sloEndpoint)	Adds a new single logout service endpoint of this service provider.
SamlServiceProviderBuilder	sloHandler(SamlSingleLogoutHandler sloHandler)	Sets a SamlSingleLogoutHandler which handles SAML messages for a single sign-on.
SamlServiceProviderBuilder	ssoHandler(SamlSingleSignOnHandler ssoHandler)	Sets a SamlSingleSignOnHandler which handles SAML messages for a single sign-on.

Methods inherited from class java.lang.Object

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

Method Details

authorizer

public SamlServiceProviderBuilder authorizer(Authorizer<HttpRequest> authorizer)

Set an Authorizer which is used for this service provider's authentication.

entityId

public SamlServiceProviderBuilder entityId(String entityId)

Sets an entity ID for this service provider.

credentialResolver

public SamlServiceProviderBuilder credentialResolver(org.opensaml.security.credential.CredentialResolver credentialResolver)

Sets a CredentialResolver for this service provider.

signingKey

public SamlServiceProviderBuilder signingKey(String signingKey)

Sets a signing key name for this service provider.

encryptionKey

public SamlServiceProviderBuilder encryptionKey(String encryptionKey)

Sets an encryption key name for this service provider.

signatureAlgorithm

public SamlServiceProviderBuilder signatureAlgorithm(String signatureAlgorithm)

Sets a signature algorithm which is used for signing by this service provider.

hostname

public SamlServiceProviderBuilder hostname(String hostname)

Sets a hostname of this service provider.

scheme

public SamlServiceProviderBuilder scheme(SessionProtocol scheme)

Sets a protocol scheme of this service provider.

port

public SamlServiceProviderBuilder port(int port)

Sets a port of this service provider.

schemeAndPort

public SamlServiceProviderBuilder schemeAndPort(ServerPort serverPort)

Sets a ServerPort of this service provider.

metadataPath

public SamlServiceProviderBuilder metadataPath(String metadataPath)

Sets a URL for retrieving a metadata of this service provider.

idpConfigSelector

public SamlServiceProviderBuilder idpConfigSelector(SamlIdentityProviderConfigSelector idpConfigSelector)

Sets a SamlIdentityProviderConfigSelector which determines a suitable idp for a request.

sloEndpoint

public SamlServiceProviderBuilder sloEndpoint(SamlEndpoint sloEndpoint)

Adds a new single logout service endpoint of this service provider.

requestIdManager

public SamlServiceProviderBuilder requestIdManager(SamlRequestIdManager requestIdManager)

Sets a SamlRequestIdManager which creates and validates a SAML request ID.

ssoHandler

public SamlServiceProviderBuilder ssoHandler(SamlSingleSignOnHandler ssoHandler)

Sets a SamlSingleSignOnHandler which handles SAML messages for a single sign-on.

sloHandler

public SamlServiceProviderBuilder sloHandler(SamlSingleLogoutHandler sloHandler)

Sets a SamlSingleLogoutHandler which handles SAML messages for a single sign-on.

idp

public SamlIdentityProviderConfigBuilder idp()

Returns a SamlIdentityProviderConfigBuilder to configure a new idp for authentication.

acs

@Deprecated
public SamlAssertionConsumerConfigBuilder acs()

Deprecated.

Use acs(SamlEndpoint).

Returns a SamlAssertionConsumerConfigBuilder to configure a new assertion consumer service of this service provider.

acs

public SamlAssertionConsumerConfigBuilder acs(SamlEndpoint endpoint)

Returns a SamlAssertionConsumerConfigBuilder to configure a new assertion consumer service of this service provider.

build

public SamlServiceProvider build()

Builds a SamlServiceProvider which helps a Server have a SAML-based authentication.