public class ServiceSchemaManager extends Object
ServiceSchemaManager
provides interfaces to manage
the service's schema. It provides access to ServiceSchema
,
which represents a single "schema" in the service.Constructor and Description |
---|
ServiceSchemaManager(SSOToken token,
String serviceName,
String version)
Creates an instance of
ServiceSchemaManager for the given service and version
pair. |
Modifier and Type | Method and Description |
---|---|
String |
addListener(ServiceListener listener)
Registers for changes to service's schema.
|
boolean |
equals(Object o)
Returns true if the given object equals this
object.
|
ServiceSchema |
getDynamicSchema()
Returns the dynamic service configuration schema.
|
ServiceSchema |
getGlobalSchema()
Returns the global service configuration schema.
|
String |
getI18NFileName()
Returns the I18N properties file name for the
service.
|
String |
getI18NJarURL()
Returns the URL of the JAR file that contains the
I18N properties file.
|
String |
getI18NKey()
Returns i18nKey of the schema.
|
String |
getName()
Returns the name of the service.
|
ServiceSchema |
getOrganizationSchema()
Returns the organization service configuration
schema.
|
ServiceSchema |
getPolicySchema()
Returns the policy service configuration schema.
|
String |
getPropertiesViewBeanURL()
Returns URL of the view bean for the service
|
InputStream |
getSchema()
Returns the service schema in XML for this service.
|
ServiceSchema |
getSchema(SchemaType type)
Returns the configuration schema for the given
schema type
|
ServiceSchema |
getSchema(String type)
Returns the configuration schema for the given
schema type
|
Set |
getSchemaTypes()
Returns the schema types available with this
service.
|
Set |
getServiceAttributeNames(SchemaType type)
Returns the attribute schemas for the given schema
type excluding status and service identifier attributes.
|
String |
getServiceHierarchy()
Returns the service's hierarchy.
|
ServiceSchema |
getUserSchema()
Returns the user service configuration schema.
|
String |
getVersion()
Returns the version of the service.
|
void |
removeListener(String listenerID)
Removes the listener from the service for the given
listener ID.
|
void |
replaceSchema(InputStream xmlServiceSchema)
Replaces the existing service schema with the given
schema defined by the XML input stream that follows the SMS DTD.
|
void |
setI18NFileName(String url)
Sets the I18N properties file name for the service
|
void |
setI18NJarURL(String url)
Sets the URL of the JAR file that contains the I18N
properties
|
void |
setI18NKey(String i18nKey)
Sets the i18nKey of the schema.
|
void |
setPropertiesViewBeanURL(String url)
Sets the URL of the view bean for the service.
|
void |
setServiceHierarchy(String newhierarchy)
Sets the service's hierarchy
|
String |
toString()
Returns the string representation of the Service
Schema.
|
public ServiceSchemaManager(SSOToken token, String serviceName, String version) throws SMSException, SSOException
ServiceSchemaManager
for the given service and version
pair. It requires an user identity, that will used to perform operations
with. It is assumed that the application calling this constructor should
authenticate the user.token
- single sign on token of the user identity on whose behalf the
operations are performed.serviceName
- the name of the service.version
- the version of the service.SMSException
- if an error occurred while trying to perform the operationSSOException
- if the single sign on token is invalid or expiredpublic String getVersion()
public String getI18NFileName()
public void setI18NFileName(String url) throws SMSException, SSOException
url
- properties file nameSMSException
- if an error occurred while trying to perform the operationSSOException
- if the single sign on token is invalid or expiredpublic String getI18NJarURL()
CLASSPATH
.I18N
properties file.public void setI18NJarURL(String url) throws SMSException, SSOException
url
- URLSMSException
- if an error occurred while trying to perform the operationSSOException
- if the single sign on token is invalid or expiredpublic String getServiceHierarchy()
public void setServiceHierarchy(String newhierarchy) throws SMSException, SSOException
newhierarchy
- service hierarchySMSException
- if an error occurred while trying to perform the operationSSOException
- if the single sign on token is invalid or expiredpublic String getI18NKey()
public void setI18NKey(String i18nKey) throws SMSException, SSOException
i18nKey
- i18nKey
of the schema.SMSException
- if an error occurred while trying to perform the operation.SSOException
- if the single sign on token is invalid or expired.public String getPropertiesViewBeanURL()
public void setPropertiesViewBeanURL(String url) throws SMSException, SSOException
url
- of the view bean for the service.SMSException
- if an error occurred while trying to perform the operation.SSOException
- if the single sign on token is invalid or expired.public Set getSchemaTypes() throws SMSException
SchemaTypes
in this service.SMSException
- if an error occurred while trying to perform the operationpublic ServiceSchema getSchema(String type) throws SMSException
type
- schema type.SMSException
- if an error occurred while trying to perform the operationpublic ServiceSchema getSchema(SchemaType type) throws SMSException
type
- schema type.SMSException
- if an error occurred while trying to perform the operationpublic Set getServiceAttributeNames(SchemaType type) throws SMSException
type
- schema type.SMSException
- if an error occurred while trying to perform the operationpublic ServiceSchema getGlobalSchema() throws SMSException
SMSException
- if an error occurred while trying to perform the operationpublic ServiceSchema getOrganizationSchema() throws SMSException
SMSException
- if an error occurred while trying to perform the operationpublic ServiceSchema getDynamicSchema() throws SMSException
SMSException
- if an error occurred while trying to perform the operationpublic ServiceSchema getUserSchema() throws SMSException
SMSException
- if an error occurred while trying to perform the operationpublic ServiceSchema getPolicySchema() throws SMSException
SMSException
- if an error occurred while trying to perform the operationpublic InputStream getSchema() throws SMSException
SMSException
- if an error occurred while trying to perform the operationpublic void replaceSchema(InputStream xmlServiceSchema) throws SSOException, SMSException
xmlServiceSchema
- the XML format of the service schemaSMSException
- if an error occurred while trying to perform the operationSSOException
- if the single sign on token is invalid or expiredIOException
- if an error occurred with the InputStream
public String addListener(ServiceListener listener)
listener
- callback object that will be invoked when schema changes.public void removeListener(String listenerID)
listenerID
- the listener ID issued when the listener was registeredCopyright © 2010-2014, ForgeRock All Rights Reserved.