org.nuxeo.apidoc.introspection

Class ServerInfo

java.lang.Object

org.nuxeo.apidoc.introspection.ServerInfo

public class ServerInfo
extends Object

The entry point to the server runtime introspection To build a description of the current running server you need to create a ServerInfo object using the method build(String, String).

Example

 ServerInfo info = ServerInfo.build();
 

The server name and version will be fetched from the runtime properties: Environment.DISTRIBUTION_NAME and Environment.DISTRIBUTION_VERSION If you want to use another name and version just call build(String, String) instead to build your server information.

After building a ServerInfo object you can start browsing the bundles deployed on the server by calling getBundles() or fetch a specific bundle given its symbolic name getBundle(String).

To write down the server information as XML use toXML(Writer) and to read it back use fromXML(Reader).

Example:

 ServerInfo info = ServerInfo.build();
 BundleInfo binfo =info.getBundle("org.nuxeo.runtime");
 System.out.println("Bundle Id: "+binfo.getBundleId());
 System.out.println("File Name: "+binfo.getFileName());
 System.out.println("Manifest: "+ binfo.getManifest());
 for (ComponentInfo cinfo : binfo.getComponents()) {
   System.out.println("Component: "+cinfo.getName());
   System.out.println(cinfo.getDocumentation());
   // find extension points provided by this component
   for (ExtensionPointInfo xpi : cinfo.getExtensionPoints()) {
     System.out.println("Extension point: "+xpi.getName());
     System.out.println("Accepted contribution classes: "+Arrays.asList(xpi.getTypes()));
     // find contributed extensions to this extension point:

   }
   // find contribution provided by this component
   for (ExtensionInfo xi : cinfo.getExtensions()) {
      System.out.println("Extension: "+xi.getId()+" to "+xi.getExtensionPoint());
      System.out.println(xi.getDocumentation());
      ...
   }
 }
 

Field Summary

Fields

Modifier and Type	Field and Description
protected List<Class<?>>	allSpi
protected Map<String,BundleInfo>	bundles
protected static DocumentBuilderFactory	documentBuilderFactory
static String	META_INF_MANIFEST_MF
protected String	name
static String	POM_PROPERTIES
static String	POM_XML
protected String	version
protected static XPathFactory	xpathFactory

Constructor Summary

Constructors

Constructor and Description
ServerInfo(String name, String version)
ServerInfo(String name, String version, Set<BundleInfo> bundles)

Method Summary

Modifier and Type	Method and Description
void	addBundle(BundleInfo bundle)
void	addBundle(Collection<BundleInfo> someBundles)
static ServerInfo	build()
static ServerInfo	build(String name, String version)
protected static BundleInfoImpl	computeBundleInfo(org.osgi.framework.Bundle bundle)
static ServerInfo	fromXML(File file)
static ServerInfo	fromXML(Reader reader)
List<Class<?>>	getAllSpi()
BundleInfo	getBundle(String id)
Collection<BundleInfo>	getBundles()
String	getName()
protected static List<Class<?>>	getSPI(Class<?> klass)
String	getVersion()
protected static boolean	isServiceOverriden(RegistrationInfo ri, String serviceName)
void	toXML(Writer writer)

Methods inherited from class java.lang.Object

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

Field Detail

META_INF_MANIFEST_MF

public static final String META_INF_MANIFEST_MF

See Also:

Constant Field Values

POM_XML

public static final String POM_XML

See Also:

Constant Field Values

POM_PROPERTIES

public static final String POM_PROPERTIES

See Also:

Constant Field Values

documentBuilderFactory

protected static final DocumentBuilderFactory documentBuilderFactory

xpathFactory

protected static final XPathFactory xpathFactory

name

protected final String name

version

protected final String version

bundles

protected final Map<String,BundleInfo> bundles

allSpi

protected final List<Class<?>> allSpi

Constructor Detail

ServerInfo

public ServerInfo(String name,
                  String version)

ServerInfo

public ServerInfo(String name,
                  String version,
                  Set<BundleInfo> bundles)

Method Detail

getName

public String getName()

getVersion

public String getVersion()

getBundles

public Collection<BundleInfo> getBundles()

addBundle

public void addBundle(BundleInfo bundle)

addBundle

public void addBundle(Collection<BundleInfo> someBundles)

getBundle

public BundleInfo getBundle(String id)

build

public static ServerInfo build()

computeBundleInfo

protected static BundleInfoImpl computeBundleInfo(org.osgi.framework.Bundle bundle)

getSPI

protected static List<Class<?>> getSPI(Class<?> klass)

build

public static ServerInfo build(String name,
                               String version)

isServiceOverriden

protected static boolean isServiceOverriden(RegistrationInfo ri,
                                            String serviceName)

toXML

public void toXML(Writer writer)
           throws IOException

Throws:

IOException

fromXML

public static ServerInfo fromXML(File file)
                          throws IOException

Throws:

IOException

fromXML

public static ServerInfo fromXML(Reader reader)

getAllSpi

public List<Class<?>> getAllSpi()