Package com.iizix.ws.server

Class Descriptor

java.lang.Object

com.iizix.ws.server.Descriptor

All Implemented Interfaces:

IPluginDescriptor<WebServiceProp>

public class Descriptor
extends java.lang.Object
implements IPluginDescriptor<WebServiceProp>

Plug-in descriptor used for the Server to load the plug-in's XML schema and get the appropriate class loader.

Author:

Christopher Mindus

Constructor Summary

Constructors

Constructor	Description
Descriptor()	Constructor.

Method Summary

Modifier and Type	Method	Description
java.lang.ClassLoader	getClassLoader()	Gets the class loader to use for loading properties classes.
java.util.List<java.net.URL>	getClasspathEntries()	Gets the URL's to the required classpath entries when running in the Server.
java.lang.String	getDescription()	Gets the description of the plug-in.
java.lang.String	getID()	Gets the ID of the plug-in, e.g.
java.lang.String	getModuleDirectory()	Gets the directory name in Module projects.
java.lang.String	getModuleFileExtension()	Gets the file extension used in Module projects, null for all.
java.net.URL	getPropertiesURL()	Gets the properties file URL for "properties.xml".
java.lang.Class<WebServiceProp>	getPropertyClass()	Gets the property class for files.
java.lang.Class<WebServiceProp>[]	getPropertyClasses()	Gets the property class for files.
java.lang.String	getServerID()	Gets the ID of the plug-in, e.g.

Methods inherited from class java.lang.Object

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

Constructor Detail

Descriptor

public Descriptor()

Constructor.

Method Detail

getID

public java.lang.String getID()

Gets the ID of the plug-in, e.g. "com.iizigo.db". Predefined descriptors such as Images, Panels, etc, return null.

Specified by:

getID in interface IPluginDescriptor<WebServiceProp>

Returns:

Predefined descriptors such as Images, Panels, etc, return null.

getServerID

public java.lang.String getServerID()

Gets the ID of the plug-in, e.g. "com.iizix.ws". Predefined descriptors such as Images, Panels, etc, return null.

Specified by:

getServerID in interface IPluginDescriptor<WebServiceProp>

Returns:

Predefined descriptors such as Images, Panels, etc, return null.

getDescription

public java.lang.String getDescription()

Gets the description of the plug-in.

Specified by:

getDescription in interface IPluginDescriptor<WebServiceProp>

Returns:

The description.

getPropertiesURL

public java.net.URL getPropertiesURL()

Gets the properties file URL for "properties.xml".

Specified by:

getPropertiesURL in interface IPluginDescriptor<WebServiceProp>

Returns:

The URL for the properties file.

getClassLoader

public java.lang.ClassLoader getClassLoader()

Gets the class loader to use for loading properties classes.

Specified by:

getClassLoader in interface IPluginDescriptor<WebServiceProp>

Returns:

A class loader or null to use the default class loader.

getModuleDirectory

public java.lang.String getModuleDirectory()

Gets the directory name in Module projects.

Specified by:

getModuleDirectory in interface IPluginDescriptor<WebServiceProp>

Returns:

The module directory name.

getModuleFileExtension

public java.lang.String getModuleFileExtension()

Gets the file extension used in Module projects, null for all.

Specified by:

getModuleFileExtension in interface IPluginDescriptor<WebServiceProp>

Returns:

The file extension used in Module projects, null for all.

getPropertyClass

public java.lang.Class<WebServiceProp> getPropertyClass()

Gets the property class for files.

Specified by:

getPropertyClass in interface IPluginDescriptor<WebServiceProp>

Returns:

The main property class used, null if there are multiple ones, in which case the IPluginDescriptor.getPropertyClasses() method must be used.

getPropertyClasses

public java.lang.Class<WebServiceProp>[] getPropertyClasses()

Gets the property class for files.

Specified by:

getPropertyClasses in interface IPluginDescriptor<WebServiceProp>

Returns:

The main property class used.

getClasspathEntries

public java.util.List<java.net.URL> getClasspathEntries()

Gets the URL's to the required classpath entries when running in the Server. This method is also called from the Designer, and the reply should include a representation of the same libraries or paths.

Specified by:

getClasspathEntries in interface IPluginDescriptor<WebServiceProp>

Returns:

A list of the classpath entries, or null for no special processing.