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

com.sas.services.deployment
Class MetadataSourceFactory

java.lang.Object
  |
  +--com.sas.services.deployment.MetadataSourceFactory

public final class MetadataSourceFactory

extends Object

Factory which manafactures a metadata source based upon values specified in a foundation services properties file.

Foundation services deployment metadata may be queried from either a SAS Metadata Server or from a services deployment file which has been exported from a server using the Foundation Services Manager plug-in to the SAS Management Console.

Query metadata from a SAS Metadata Server

If the foundation services deployment metadata is to be queried from a SAS Metadata Server, specify the following properties.

Property	Note
software_component	software component name
deployment_group_[n]	deployment group restrictions
omr_host	SAS Metadata Server's host
omr_port	SAS Metadata Server's port
omr_repository	SAS Metadata Server repository
omr_user	User's logon id
omr_password	User's password

Query metadata from a URL

If the foundation services deployment metadata is to be queried from a URL (i.e. local file), specify the following properties.

Property	Note
software_component	software component name
deployment_group_[n]	deployment group restrictions
url	URL to a foundation services deployment file

Restricting deployment to specified group(s):

• This is an optional property and should only be specified if there are some deployment groupings of services which are not to be deployed.

  For example, if the foundation services deployment contains three deployment groups "Core", "Stored Process", and "Events" and one only wishes to deploy the services in the "Core" and "Stored Process" groups, then one would specify the following two properties:

  • deployment_group_1=Core
  • deployment_group_2=Stored Process
  Note that we've omitted the "Events" deployment group because we do not want to include this group's services in the deployment.

  If all foundation services are to be deployed, then there is no need to designate any deployment group restrictions in the properties file.

Properties File Character Encoding

Note that the ISO 8859-1 character encoding is used is used to read the properties file. For characters that cannot be directly represented in this encoding, Unicode escapes are used; however, only a single 'u' character is allowed in an escape sequence. The native2ascii tool can be used to convert property files to and from other character encodings.

Since:

1.1.2

Field Summary

static String	PROPERTY_DEPLOYMENTGROUP Property designating the name of a metadata Tree which whose members represent a grouping of services which are to be deployed.
static String	PROPERTY_METADATASERVER_HOST Property designating the name of the host on which a SAS Metadata Server is running.
static String	PROPERTY_METADATASERVER_PORT Property designating the name of the port on which a SAS Metadata Server is listening for connections.
static String	PROPERTY_METADATASERVER_REPOSITORY Property designating the name of the SAS Metadata Server's repository which contains the foundation services deployment metadata.
static String	PROPERTY_METADATASERVER_USERID Property designating the user ID which should be used to establish a connection to the SAS Metadata Server.
static String	PROPERTY_METADATASERVER_USERPASSWORD Property designating the user password which should be used to establish a connection to the SAS Metadata Server.
static String	PROPERTY_SOFTWARECOMPONENT Property designating the name of the metadata SoftwareComponent associated with the foundation services deployment which is to be queried.
static String	PROPERTY_URL Property designating a URL to a metadata source from which foundation services metadata can be queried.

Method Summary

static MetadataSourceInterface

newMetadataSource(Properties properties) Creates a metadata source based upon the specified properties.

Methods inherited from class java.lang.Object

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

Field Detail

PROPERTY_SOFTWARECOMPONENT

public static final String PROPERTY_SOFTWARECOMPONENT

Property designating the name of the metadata SoftwareComponent associated with the foundation services deployment which is to be queried.

PROPERTY_DEPLOYMENTGROUP

public static final String PROPERTY_DEPLOYMENTGROUP

Property designating the name of a metadata Tree which whose members represent a grouping of services which are to be deployed. Suffix this value with an integer value beginning with "1" and incremented by one for each additional deployment group that is to be included.

This is an optional property which is only required if the foundation services deployment metadata contains more than one services deployment group and services in some groups should not be deployed. deployment group restrictions

If all services should be deployed, then there is no need to specify this property since no restrictions are being applied.

PROPERTY_METADATASERVER_HOST

public static final String PROPERTY_METADATASERVER_HOST

Property designating the name of the host on which a SAS Metadata Server is running.

PROPERTY_METADATASERVER_PORT

public static final String PROPERTY_METADATASERVER_PORT

Property designating the name of the port on which a SAS Metadata Server is listening for connections.

PROPERTY_METADATASERVER_USERID

public static final String PROPERTY_METADATASERVER_USERID

Property designating the user ID which should be used to establish a connection to the SAS Metadata Server.

PROPERTY_METADATASERVER_USERPASSWORD

public static final String PROPERTY_METADATASERVER_USERPASSWORD

Property designating the user password which should be used to establish a connection to the SAS Metadata Server. This password should be a SAS001 encoded string.

PROPERTY_METADATASERVER_REPOSITORY

public static final String PROPERTY_METADATASERVER_REPOSITORY

Property designating the name of the SAS Metadata Server's repository which contains the foundation services deployment metadata.

PROPERTY_URL

public static final String PROPERTY_URL

Property designating a URL to a metadata source from which foundation services metadata can be queried. Typically this value will specify the URL to a foundation services deployment file.

Use this value if foundation services deployment metadata is to be queried from a URL source instead of the SAS Metadata Server.

Method Detail

newMetadataSource

public static final MetadataSourceInterface newMetadataSource(Properties properties)
                                                       throws ServiceException

Creates a metadata source based upon the specified properties. Properties can be specified in a file containing the metadata source information describing an OMR or URL metadata source.

The syntax of these files is described in the package documentation.

The following links provide sample properties files.

• properties file specifying URL metadata source
• properties file specifying OMR metadata source

Parameters:

properties - Properties describing how to access the metadata source.

Returns:

Metadata source

Throws:

ServiceException - if unable to create a new metadata source.

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