com.axemble.vdoc.sdk.interfaces

Interface ISsoDomain

All Superinterfaces:

IDeletionSupport, IElement, IProtocolSupport, ISecuritySupport, Serializable

public interface ISsoDomain
extends IElement, IProtocolSupport, IDeletionSupport, ISecuritySupport

This interface represents a sso domain.

Author:

ploureiro

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ISsoDomain.AuthenticationType This interface represents the various authentication methods you could use.

Method Summary

Modifier and Type	Method and Description
void	clearDomainParameters() Remove all domain parameter
String	getAcceptCharset()
String	getBaseUrl()
String	getDescription()
Collection<? extends ISsoDomainParameter>	getDomainParameters() get all domain parameter
String	getLabel()
String	getLoginUrl()
String	getMethod()
String	getName()
IOrganization	getOrganization() Gets the organization object.
Collection<? extends ISsoDomainParameter>	getOverridableParameters() get all domain parameter that the user can overridable
void	setAcceptCharset(String acceptCharset) Sets the acceptCharset of the domain.
void	setBaseUrl(String baseUrl) Sets the base url of the domain.
void	setDescription(String description) Sets the description of the domain.
void	setLabel(String label) Sets the label of the domain.
void	setLoginUrl(String loginUrl) Sets the login url of the domain.
void	setMethod(String method) Sets the authentification method of the domain.
void	setOrganization(IOrganization organization) Set the organization of the domain.

Methods inherited from interface com.axemble.vdoc.sdk.interfaces.IElement

getId, getModule, getNativeObject, getPath, save

Methods inherited from interface com.axemble.vdoc.sdk.supports.IDeletionSupport

delete

Methods inherited from interface com.axemble.vdoc.sdk.supports.IProtocolSupport

getProtocolURI, getProtocolURI

Method Detail

getName

String getName()

Returns:

the name of the domain.

getLabel

String getLabel()

Returns:

the label of the domain.

setLabel

void setLabel(String label)

Sets the label of the domain.

Parameters:

label - the new label to set.

getDescription

String getDescription()

Returns:

the description of the domain.

setDescription

void setDescription(String description)

Sets the description of the domain.

Parameters:

description - the new description to set.

getBaseUrl

String getBaseUrl()

Returns:

the base url of the domain

setBaseUrl

void setBaseUrl(String baseUrl)

Sets the base url of the domain.

Parameters:

baseUrl - the new base url to set.

getLoginUrl

String getLoginUrl()

Returns:

the login url of the domain

setLoginUrl

void setLoginUrl(String loginUrl)

Sets the login url of the domain.

Parameters:

loginUrl - the new login url to set.

setMethod

void setMethod(String method)

Sets the authentification method of the domain.

Parameters:

method - the method to set.

getMethod

String getMethod()

Returns:

the authentifiaction method of the domain

setAcceptCharset

void setAcceptCharset(String acceptCharset)

Sets the acceptCharset of the domain.

Parameters:

acceptCharset - the accept charset to set.

getAcceptCharset

String getAcceptCharset()

Returns:

the acceptCharset of the domain

setOrganization

void setOrganization(IOrganization organization)

Set the organization of the domain.

Parameters:

organization - the organization to set.

getOrganization

IOrganization getOrganization()

Gets the organization object.

Returns:

A IOrganization object.

getDomainParameters

Collection<? extends ISsoDomainParameter> getDomainParameters()

get all domain parameter

Returns:

a java.util.Collection of ISsoDomainParameter objects.

getOverridableParameters

Collection<? extends ISsoDomainParameter> getOverridableParameters()

get all domain parameter that the user can overridable

Returns:

a java.util.Collection of ISsoDomainParameter objects.

clearDomainParameters

void clearDomainParameters()

Remove all domain parameter