Package com.sun.identity.sm

Class PluginSchema

java.lang.Object

com.sun.identity.sm.PluginSchema

public class PluginSchema
extends Object

The class PluginSchemaImpl provides the interfaces to obtain the schema information of a plugin that is configured for a service.

Field Summary

Fields

Modifier and Type	Field	Description
protected String	pluginName
protected com.sun.identity.sm.PluginSchemaImpl	psi
protected String	serviceName
protected SSOToken	token
protected String	version

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PluginSchema(SSOToken token, String serviceName, String version, String pluginName, String iName, String orgName)

Method Summary

Modifier and Type	Method	Description
AttributeSchema	getAttributeSchema(String attributeSchemaName)	Returns the schema for an attribute given the name of the attribute, defined for this plugin.
Set	getAttributeSchemaNames()	Returns the names of the schema attribute defined for the plugin.
String	getClassName()	Returns the java class name that implements the interface
protected Document	getDocumentCopy()
String	getI18NFileName()	Returns the i18n properties file name
String	getI18NJarURL()	Returns the URL for the plugin's resource bundle
String	getI18NKey()	Returns the i18n key to resource bundle that describes the plugin
String	getInterfaceName()	Returns the interface name implemented by the plugin
String	getJarURL()	Returns the URL of the jar file, the contains the complete implementation for the plugin.
String	getName()	Returns the name of the plugin schema
protected Node	getPluginSchemaNode(Document doc)
String	getPropertiesViewBeanURL()	Returns URL of the view bean for the service
protected void	replacePluginSchema(Document document)
void	setPropertiesViewBeanURL(String url)	Sets the URL of the view bean for the plugin.
String	toString()	Returns the String represenation of the Plugin schema.
String	toXML()
protected void	validate()
protected void	validatePluginSchema()

Methods inherited from class java.lang.Object

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

Field Detail

psi

protected com.sun.identity.sm.PluginSchemaImpl psi

token

protected SSOToken token

serviceName

protected String serviceName

version

protected String version

pluginName

protected String pluginName

Constructor Detail

PluginSchema

protected PluginSchema(SSOToken token,
                       String serviceName,
                       String version,
                       String pluginName,
                       String iName,
                       String orgName)
                throws SMSException

Throws:

SMSException

Method Detail

getName

public String getName()

Returns the name of the plugin schema

Returns:

name of the plugin

getInterfaceName

public String getInterfaceName()

Returns the interface name implemented by the plugin

Returns:

plugin interface name

getClassName

public String getClassName()

Returns the java class name that implements the interface

Returns:

class name that implements the interface

getJarURL

public String getJarURL()

Returns the URL of the jar file, the contains the complete implementation for the plugin.

Returns:

class name that implements the interface

getI18NJarURL

public String getI18NJarURL()

Returns the URL for the plugin's resource bundle

Returns:

URL of the plugin's resource bundle

getI18NFileName

public String getI18NFileName()

Returns the i18n properties file name

Returns:

i18n properties file name

getPropertiesViewBeanURL

public String getPropertiesViewBeanURL()

Returns URL of the view bean for the service

Returns:

URL for view bean

setPropertiesViewBeanURL

public void setPropertiesViewBeanURL(String url)
                              throws SMSException,
                                     SSOException

Sets the URL of the view bean for the plugin.

Parameters:

url - of the view bean for the plugin.

Throws:

SMSException - if an error occurred while trying to perform the operation.

SSOException - if the single sign on token is invalid or expired.

getI18NKey

public String getI18NKey()

Returns the i18n key to resource bundle that describes the plugin

Returns:

i18n index key to the resource bundle

getAttributeSchemaNames

public Set getAttributeSchemaNames()

Returns the names of the schema attribute defined for the plugin.

Returns:

names of schema attributes defined for the plugin

getAttributeSchema

public AttributeSchema getAttributeSchema(String attributeSchemaName)

Returns the schema for an attribute given the name of the attribute, defined for this plugin.

Parameters:

attributeSchemaName - name of the schema attribute

Returns:

schema for the attribute

toString

public String toString()

Returns the String represenation of the Plugin schema.

Overrides:

toString in class Object

validate

protected void validate()

validatePluginSchema

protected void validatePluginSchema()
                             throws SMSException

Throws:

SMSException

getDocumentCopy

protected Document getDocumentCopy()
                            throws SMSException

Throws:

SMSException

getPluginSchemaNode

protected Node getPluginSchemaNode(Document doc)
                            throws SMSException

Throws:

SMSException

replacePluginSchema

protected void replacePluginSchema(Document document)
                            throws SSOException,
                                   SMSException

Throws:

SSOException

SMSException

toXML

public String toXML()
             throws SMSException

Throws:

SMSException