Package org.apache.synapse.libraries.model

Interface Library

All Superinterfaces:

SynapseArtifact

All Known Implementing Classes:

SynapseLibrary

public interface Library
extends SynapseArtifact

Author:

dushan

Method Summary

Modifier and Type	Method	Description
Object	getArtifact(String artifacName)	return synapse lib artifact deployed by this library with the given artifact name
String	getArtifactDescription(String artifactName)	gives the Artifact description for the given artifact name (if available)
Map<String,Object>	getArtifacts()
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	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 for each and every namespace this should be called when a import is taking place
void	setFileName(String fileName)
void	setLibStatus(boolean status)
boolean	unLoadLibrary()	unload all library artifacts on this library this should be called when a import is no longer valid/ non-existent or library being undeployed

Methods inherited from interface org.apache.synapse.SynapseArtifact

getDescription, setDescription

Method Detail

getQName

QName getQName()

get Fully qualified Name of the Library

Returns:

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

getPackage

String getPackage()

returns the package that this Library belongs to

Returns:

package name

getArtifact

Object getArtifact(String artifacName)

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

Parameters:

artifacName -

Returns:

getArtifacts

Map<String,Object> getArtifacts()

getArtifactDescription

String getArtifactDescription(String artifactName)

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

Parameters:

artifactName -

Returns:

getLibArtifactDetails

Map<String,String> getLibArtifactDetails()

loadLibrary

boolean loadLibrary()

load all library artifacts on this library for each and every namespace this should be called when a import is taking place

Returns:

success

unLoadLibrary

boolean unLoadLibrary()

unload all library artifacts on this library this should be called when a import is no longer valid/ non-existent or library being undeployed

Returns:

success

getLibClassLoader

ClassLoader getLibClassLoader()

Returns:

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

getFileName

String getFileName()

setFileName

void setFileName(String fileName)

getLocalEntryArtifacts

Map<String,Object> getLocalEntryArtifacts()

Returns the list of local entry definitions

Returns:

getLocalEntries

List<String> getLocalEntries()

getLibStatus

boolean getLibStatus()

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

Returns:

setLibStatus

void setLibStatus(boolean status)

Parameters:

status -