Package org.apache.synapse.libraries.model

Class SynapseLibrary

java.lang.Object

org.apache.synapse.libraries.model.SynapseLibrary

All Implemented Interfaces:

Library, SynapseArtifact

public class SynapseLibrary
extends Object
implements Library

Field Summary

Fields

Modifier and Type	Field	Description
List<LibraryArtifact.Dependency>	dependencies
protected QName	qualifiedName	this is the logical name of the Synapse library which constitutes of [package + library name]

Constructor Summary

Constructors

Constructor	Description
SynapseLibrary(String name, String packageName)

Method Summary

Modifier and Type	Method	Description
void	addArtifactDescription(LibraryArtifact artifact)
void	addComponent(String qualifiedName, Object libComponent)
void	addDependency(LibraryArtifact.Dependency artifactDep)
void	clear()
Object	getArtifact(String artifacName)	return synapse lib artifact deployed by this library with the given Local name
String	getArtifactDescription(String artifactName)	gives the Artifact description for the given artifact name (if available)
Map<String,Object>	getArtifacts()
String	getDescription()	Retrieves the description of the artifact
String	getFileName()
Map<String,String>	getLibArtifactDetails()
ClassLoader	getLibClassLoader()
boolean	getLibStatus()	Gets the library status which can determine whether the library should be available during run time
List<String>	getLocalEntries()
Map<String,Object>	getLocalEntryArtifacts()	Returns the list of local entry definitions
String	getName()
String	getPackage()	returns the package that this Library belongs to
QName	getQName()	get Fully qualified Name of the Library
boolean	loadLibrary()	load all library artifacts on this library this should be called when a import is taking place
void	loadLibrary(String artifactDependencyName)	load all library artifacts on this library for the given QName this should be called when a import is taking place
void	removeComponent(String qualifiedName)
boolean	resolveDependencies(List<LibraryArtifact> unresolvedPrincipalArtifactList)
void	setDescription(String description)	Set the description of the artifact
void	setFileName(String fileName)
void	setLibClassLoader(ClassLoader libClassLoader)
void	setLibStatus(boolean status)
String	toString()
boolean	unLoadLibrary()	unload all library artifacts on this library for the given QName this should be called when a import is no longer valid/ non-existent

Methods inherited from class java.lang.Object

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

Field Detail

qualifiedName

protected QName qualifiedName

this is the logical name of the Synapse library which constitutes of [package + library name]

dependencies

public List<LibraryArtifact.Dependency> dependencies

Constructor Detail

SynapseLibrary

public SynapseLibrary(String name,
                      String packageName)

Method Detail

getQName

public QName getQName()

Description copied from interface: Library

get Fully qualified Name of the Library

Specified by:

getQName in interface Library

Returns:

returns the logical name of the Synapse library which constitutes of [package + library name]

getName

public String getName()

addDependency

public void addDependency(LibraryArtifact.Dependency artifactDep)

addComponent

public void addComponent(String qualifiedName,
                         Object libComponent)

addArtifactDescription

public void addArtifactDescription(LibraryArtifact artifact)

getArtifactDescription

public String getArtifactDescription(String artifactName)

Description copied from interface: Library

gives the Artifact description for the given artifact name (if available)

Specified by:

getArtifactDescription in interface Library

Returns:

getLibArtifactDetails

public Map<String,String> getLibArtifactDetails()

Specified by:

getLibArtifactDetails in interface Library

removeComponent

public void removeComponent(String qualifiedName)

resolveDependencies

public boolean resolveDependencies(List<LibraryArtifact> unresolvedPrincipalArtifactList)

loadLibrary

public boolean loadLibrary()

load all library artifacts on this library this should be called when a import is taking place

Specified by:

loadLibrary in interface Library

Returns:

success

loadLibrary

public void loadLibrary(String artifactDependencyName)

load all library artifacts on this library for the given QName this should be called when a import is taking place

unLoadLibrary

public boolean unLoadLibrary()

unload all library artifacts on this library for the given QName this should be called when a import is no longer valid/ non-existent

Specified by:

unLoadLibrary in interface Library

Returns:

success

getLibClassLoader

public ClassLoader getLibClassLoader()

Specified by:

getLibClassLoader in interface Library

Returns:

the Class loader that can be used to load classes/resources under this library

getFileName

public String getFileName()

Specified by:

getFileName in interface Library

setFileName

public void setFileName(String fileName)

Specified by:

setFileName in interface Library

clear

public void clear()

getArtifact

public Object getArtifact(String artifacName)

return synapse lib artifact deployed by this library with the given Local name

Specified by:

getArtifact in interface Library

Parameters:

artifacName -

Returns:

getArtifacts

public Map<String,Object> getArtifacts()

Specified by:

getArtifacts in interface Library

toString

public String toString()

Overrides:

toString in class Object

getPackage

public String getPackage()

Description copied from interface: Library

returns the package that this Library belongs to

Specified by:

getPackage in interface Library

Returns:

package name

setDescription

public void setDescription(String description)

Description copied from interface: SynapseArtifact

Set the description of the artifact

Specified by:

setDescription in interface SynapseArtifact

Parameters:

description - tobe set to the artifact

getDescription

public String getDescription()

Description copied from interface: SynapseArtifact

Retrieves the description of the artifact

Specified by:

getDescription in interface SynapseArtifact

Returns:

description of the artifact

setLibClassLoader

public void setLibClassLoader(ClassLoader libClassLoader)

getLocalEntryArtifacts

public Map<String,Object> getLocalEntryArtifacts()

Description copied from interface: Library

Returns the list of local entry definitions

Specified by:

getLocalEntryArtifacts in interface Library

Returns:

getLocalEntries

public List<String> getLocalEntries()

Specified by:

getLocalEntries in interface Library

getLibStatus

public boolean getLibStatus()

Description copied from interface: Library

Gets the library status which can determine whether the library should be available during run time

Specified by:

getLibStatus in interface Library

Returns:

setLibStatus

public void setLibStatus(boolean status)

Specified by:

setLibStatus in interface Library