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()
Returns aSamlAssertionConsumerConfigBuilder
to configure a new assertion consumer service of this service provider.SamlServiceProviderBuilder
authorizer(Authorizer<HttpRequest> authorizer)
Set anAuthorizer
which is used for this service provider's authentication.SamlServiceProvider
build()
Builds aSamlServiceProvider
which helps aServer
have a SAML-based authentication.SamlServiceProviderBuilder
credentialResolver(org.opensaml.security.credential.CredentialResolver credentialResolver)
Sets aCredentialResolver
for this service provider.SamlServiceProviderBuilder
encryptionKey(String encryptionKey)
Sets anencryption
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 aSamlIdentityProviderConfigBuilder
to configure a new idp for authentication.SamlServiceProviderBuilder
idpConfigSelector(SamlIdentityProviderConfigSelector idpConfigSelector)
Sets aSamlIdentityProviderConfigSelector
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 aSamlRequestIdManager
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 aServerPort
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 asigning
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 aSamlSingleLogoutHandler
which handles SAML messages for a single sign-on.SamlServiceProviderBuilder
ssoHandler(SamlSingleSignOnHandler ssoHandler)
Sets aSamlSingleSignOnHandler
which handles SAML messages for a single sign-on.
-
Method Details
-
authorizer
Set anAuthorizer
which is used for this service provider's authentication. -
entityId
Sets an entity ID for this service provider. -
credentialResolver
public SamlServiceProviderBuilder credentialResolver(org.opensaml.security.credential.CredentialResolver credentialResolver)Sets aCredentialResolver
for this service provider. -
signingKey
Sets asigning
key name for this service provider. -
encryptionKey
Sets anencryption
key name for this service provider. -
signatureAlgorithm
Sets a signature algorithm which is used for signing by this service provider. -
hostname
Sets a hostname of this service provider. -
scheme
Sets a protocol scheme of this service provider. -
port
Sets a port of this service provider. -
schemeAndPort
Sets aServerPort
of this service provider. -
metadataPath
Sets a URL for retrieving a metadata of this service provider. -
idpConfigSelector
public SamlServiceProviderBuilder idpConfigSelector(SamlIdentityProviderConfigSelector idpConfigSelector)Sets aSamlIdentityProviderConfigSelector
which determines a suitable idp for a request. -
sloEndpoint
Adds a new single logout service endpoint of this service provider. -
requestIdManager
Sets aSamlRequestIdManager
which creates and validates a SAML request ID. -
ssoHandler
Sets aSamlSingleSignOnHandler
which handles SAML messages for a single sign-on. -
sloHandler
Sets aSamlSingleLogoutHandler
which handles SAML messages for a single sign-on. -
idp
Returns aSamlIdentityProviderConfigBuilder
to configure a new idp for authentication. -
acs
Returns aSamlAssertionConsumerConfigBuilder
to configure a new assertion consumer service of this service provider. -
build
Builds aSamlServiceProvider
which helps aServer
have a SAML-based authentication.
-