org.jboss.seam.security.external.api

Interface EntityConfigurationApi

All Known Subinterfaces:

OpenIdProviderBeanApi, OpenIdProviderConfigurationApi, OpenIdRelyingPartyConfigurationApi, OpenIdRpBeanApi, SamlEntityConfigurationApi, SamlIdentityProviderConfigurationApi, SamlIdpBeanApi, SamlServiceProviderConfigurationApi, SamlSpBeanApi

All Known Implementing Classes:

OpenIdProviderBean, OpenIdRpBean, SamlEntityBean, SamlIdpBean, SamlSpBean

public interface EntityConfigurationApi

API for configuration of entities that play a role in distributed security (examples of entities are SAML identity providers, SAML service providers, OpenID relying parties and OpenID providers)

Author:

Marcel Kolsteren

Method Summary

Methods

Modifier and Type	Method and Description
String	getHostName() The host name which is used to access this application from a web browser (by the end user).
int	getPort() The port at which this application is reachable from the browser of the end user.
String	getProtocol() This property contains the protocol that is used by the entity.
void	setHostName(String hostName) See getHostName()
void	setPort(int port) See getPort()
void	setProtocol(String protocol) See getProtocol()

Method Detail

getProtocol

String getProtocol()

This property contains the protocol that is used by the entity. Either "http" or "https".

Returns:

the protocol

setProtocol

void setProtocol(String protocol)

See getProtocol()

Parameters:

protocol - protocol

getHostName

String getHostName()

The host name which is used to access this application from a web browser (by the end user).

Returns:

the host name

setHostName

void setHostName(String hostName)

See getHostName()

Parameters:

hostName - host name

getPort

int getPort()

The port at which this application is reachable from the browser of the end user. This might be another port then the port where the web container is listening to (in case of port forwarding). In most practical production employments, this port will be the standard HTTPS port, being 443.

Returns:

setPort

void setPort(int port)

See getPort()

Parameters:

port - port