*** This class provides Binary Compatibility only, not Source Compatibility ***

com.sas.services.deployment
Class Configuration

com.sas.services.deployment.Configuration

public final class Configuration

Metadata source configuration which defines the properties required to query metadata describing a SAS Foundation Services deployment from a SAS Metadata Server.

Since:

9.2

See Also:

MetadataSourceFactory

Constructor Summary

Configuration(com.sas.metadata.remote.SoftwareComponent softwareComponent)
Constructs a default instance.

Method Summary

java.lang.String	getContainerType() Gets the container type.
java.lang.String	getDescForProperty(java.lang.String propertyName) Gets a localized description for the specified property.
java.util.Properties	getProperties() Gets properties which may be used to configure a file that describes a SAS Foundation Services deployment which is to be deployed in an IOC container.
com.sas.metadata.remote.SoftwareComponent	getSoftwareComponent() Gets the software component.
java.lang.String	localizePropertyGroupName(int groupIndex) Gets a localized name for the specified group property.
java.lang.String	localizePropertyMode(java.lang.String mode) Gets a localized name for the mode property.
java.lang.String	localizePropertyName(java.lang.String propertyName) Gets a localized name for the specified property.
void	setContainerType(java.lang.String containerType) Sets the container type.
void	setDeploymentGroups(java.util.Set groupNames) Sets the groups of services which are enabled for deployment.
void	setHost(java.lang.String host) Sets the Metadata Server's host.
void	setMode(java.lang.String mode) Sets the mode that indicates whether the SAS Foundation Services deployment metadata is to be queried from a Metadata Repository or from a URL.
void	setPort(java.lang.String port) Sets the port on which the SAS Metadata Server is listening for connections.
void	setRepository(java.lang.String repository) Sets the name of the metadata repository which is to be queried to read a SAS Foundation Services deployment.
void	setSecurityPackageList(java.lang.String secpackagelist) Sets the secpackagelist.
void	setSecuritySPN(java.lang.String metaspn) Sets the service principal name ("metaspn").
void	setSoftwareComponent(com.sas.metadata.remote.SoftwareComponent softwareComponent) Sets the software component.
void	setURL(java.lang.String url) Sets the URL that can be read to obtain SAS Foundation Services deployment metadata.
void	setUserId(java.lang.String userId) Sets the user ID which will be used to connect to the SAS Metadata Server.
void	setUserPassword(java.lang.String userPassword) Sets the user's password which will be used to connect to the SAS Metadata Server.

Constructor Detail

Configuration

public Configuration(com.sas.metadata.remote.SoftwareComponent softwareComponent)
              throws com.sas.metadata.remote.MdException

Constructs a default instance.

Parameters:

softwareComponent - Metatata software component that represents the SAS Foundation Services deployment.

Throws:

com.sas.metadata.remote.MdException - if unable to construct an instance.

Method Detail

getSoftwareComponent

public com.sas.metadata.remote.SoftwareComponent getSoftwareComponent()

Gets the software component.

Returns:

Metatata software component that represents the SAS Foundation Services deployment.

getProperties

public java.util.Properties getProperties()

Gets properties which may be used to configure a file that describes a SAS Foundation Services deployment which is to be deployed in an IOC container.

Property Key	Property Value
MetadataSourceFactory.PROPERTY_SOFTWARECOMPONENT	String name of the SoftwareComponent

Returns:

Deployment properties.

setSoftwareComponent

public void setSoftwareComponent(com.sas.metadata.remote.SoftwareComponent softwareComponent)
                          throws com.sas.metadata.remote.MdException

Sets the software component.

Parameters:

softwareComponent - Metatata software component that represents the SAS Foundation Services deployment.

Throws:

com.sas.metadata.remote.MdException - if a unable to access metadata.

setContainerType

public void setContainerType(java.lang.String containerType)
                      throws java.lang.IllegalArgumentException

Sets the container type.

Parameters:

containerType - Container type. One of DeploymentContextFactory.CONTAINER_JBOSSMC or DeploymentContextFactory.CONTAINER_SPRING.

Throws:

java.lang.IllegalArgumentException - if an invalid container type is specified.

getContainerType

public java.lang.String getContainerType()

Gets the container type.

Returns:

Container type. One of DeploymentContextFactory.CONTAINER_JBOSSMC or DeploymentContextFactory.CONTAINER_SPRING or null if undefined.

setRepository

public void setRepository(java.lang.String repository)

Sets the name of the metadata repository which is to be queried to read a SAS Foundation Services deployment.

Parameters:

repository - Name of the repository that will be queried to read a SAS Foundation Services deployment.

setSecuritySPN

public void setSecuritySPN(java.lang.String metaspn)

Sets the service principal name ("metaspn").

Parameters:

metaspn - Security service principal name.

See Also:

MetadataSourceFactory.PROPERTY_SSO_SECPACKAGELIST

setSecurityPackageList

public void setSecurityPackageList(java.lang.String secpackagelist)

Sets the secpackagelist.

Parameters:

secpackagelist - Security package list. A null may be specified (e.g. login credential is used).

See Also:

MetadataSourceFactory.PROPERTY_SSO_SECPACKAGELIST

setUserId

public void setUserId(java.lang.String userId)

Sets the user ID which will be used to connect to the SAS Metadata Server.

Parameters:

userId - Login ID used to connect to the SAS Metadata Server. A null may be specified (e.g. single sign-on).

setUserPassword

public void setUserPassword(java.lang.String userPassword)

Sets the user's password which will be used to connect to the SAS Metadata Server.

Parameters:

userPassword - Login ID password used to connect to the SAS Metadata Server. A null may be specified (e.g. single sign-on).

setHost

public void setHost(java.lang.String host)

Sets the Metadata Server's host.

Parameters:

host - Metadata Server's host.

setPort

public void setPort(java.lang.String port)

Sets the port on which the SAS Metadata Server is listening for connections.

Parameters:

port - SAS Metadata Server's port.

setURL

public void setURL(java.lang.String url)

Sets the URL that can be read to obtain SAS Foundation Services deployment metadata.

Parameters:

url - URL to a SAS Foundation Services deployment.

setMode

public void setMode(java.lang.String mode)

Sets the mode that indicates whether the SAS Foundation Services deployment metadata is to be queried from a Metadata Repository or from a URL.

Parameters:

mode - Specify MetadataSourceFactory.PROPERTY_METADATASERVER_REPOSITORY if SAS Foundation Services metadata is to be queried from a SAS Metdata Repository or MetadataSourceFactory.PROPERTY_URL if the metadata is to be queried from a URL.

setDeploymentGroups

public void setDeploymentGroups(java.util.Set groupNames)

Sets the groups of services which are enabled for deployment. Groups only need to be specified if a deployment contains multiple groups and one does not want to deploy all groups. This method is used to restrict the deployment to the specified groups.

Parameters:

groupNames - Collection of String elements representing the names of the service deployment groups which are enabled for deployment. An empty collection indicates that all services are enabled for deployment.

localizePropertyName

public java.lang.String localizePropertyName(java.lang.String propertyName)

Gets a localized name for the specified property.

Parameters:

propertyName - Name of the property which is to be localized.

Returns:

Localized name for the specified property.

getDescForProperty

public java.lang.String getDescForProperty(java.lang.String propertyName)

Gets a localized description for the specified property.

Parameters:

propertyName -

Returns:

Localized name for the specified property.

localizePropertyGroupName

public java.lang.String localizePropertyGroupName(int groupIndex)

Gets a localized name for the specified group property.

Parameters:

groupIndex -

Returns:

Localized name for the specified property.

localizePropertyMode

public java.lang.String localizePropertyMode(java.lang.String mode)

Gets a localized name for the mode property.

Parameters:

mode - The source from which SAS Foundation Services metadata is to be queried.

Returns:

Localized name for the specified property.

*** This class provides Binary Compatibility only, not Source Compatibility ***