Interface Library
-
- All Superinterfaces:
SynapseArtifact
- All Known Implementing Classes:
SynapseLibrary
public interface Library extends SynapseArtifact
- Author:
- dushan
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Object
getArtifact(String artifacName)
return synapse lib artifact deployed by this library with the given artifact nameString
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 timeList<String>
getLocalEntries()
Map<String,Object>
getLocalEntryArtifacts()
Returns the list of local entry definitionsString
getPackage()
returns the package that this Library belongs toQName
getQName()
get Fully qualified Name of the Libraryboolean
loadLibrary()
load all library artifacts on this library for each and every namespace this should be called when a import is taking placevoid
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:
-
getArtifactDescription
String getArtifactDescription(String artifactName)
gives the Artifact description for the given artifact name (if available)- Parameters:
artifactName
-- Returns:
-
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:
-
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
-
-
-