LibraryManager (Java API Reference for Oracle WebLogic Server)

java.lang.Object
- weblogic.application.library.LibraryManager

All Implemented Interfaces:

LibraryProvider
```
public class LibraryManager
extends java.lang.Object
implements LibraryProvider
```
Finds requested libraries, handles their references (server side only, we keep track of each app that references a set of libraries), creates error message if references do not resolve. The Library Reference Lifecycle has 4 parts: At referencing app deployment time: - Given LibraryReference(s), find all referenced Libraries. If one or more references cannot be resolved, an error should be generated. This class handles the Library lookup logic, and provides methods for error checking. - Add references between the LibraryRuntimes, and the LibraryReferencer. This class provides access to the RuntimeMBeans of the referenced Libraries. - For auto-ref libraries, the above two steps are combined into one, using lookupAndAddAutoReferences(Type). Invocation of this operation automatically looks up the libraries for a given type and adds each one of them as a reference At referencing app undeployment: - Remove Library references to app being undeployed. Note that Access to Collections in this class has not been synchronized, because each app deployment will have its own instance of this class.

Excluded in public API Reference.

Field Summary

Fields
Modifier and Type	Field and Description
`private java.util.Collection`	`allRefs`
`private java.util.List<LibraryDefinition>`	`autoRefLibs`
`private java.util.List`	`libraries`
`private java.util.Set`	`libRefs`
`private static weblogic.application.internal.library.LibraryRegistry`	`libReg`
`private java.lang.String`	`partitionName`
`private LibraryReferencer`	`referencer`
`private java.util.List`	`resolvedRefs`
`private java.util.Collection`	`unresolvedRefs`

Constructor Summary

Constructors
Constructor and Description
`LibraryManager(LibraryReferencer referencer, java.lang.String partitionName)` Initialize with referencer, but without references.
`LibraryManager(LibraryReferencer referencer, java.lang.String partitionName, LibraryReference[] refs)` Initialize with Referencer and library references to lookup.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addReferences()` Register the LibraryReferencer with the referenced Libraries.
`private void`	`findReferencedLibraries(LibraryReference ref)`
`Library[]`	`getAutoReferencedLibraries()` Returns the auto referenced libraries.
`LibraryReference[]`	`getLibraryReferences()` Returns the LibraryReferences that resolved successfully.
`java.io.File[]`	`getOptionalPackages(LibraryReference[] refs)`
`Library[]`	`getReferencedLibraries()` Returns the Libraries for which the references resolved successfully.
`LibraryRuntimeMBean[]`	`getReferencedLibraryRuntimes()` Returns the LibraryRuntimes for which the references resolved successfully.
`LibraryReferencer`	`getReferencer()`
`Library[]`	`getUnreferencedLibraries()` Returns the Libraries that are not referenced.
`LibraryReference[]`	`getUnresolvedReferences()` Returns the references for which no Libraries were found.
`java.lang.String`	`getUnresolvedReferencesAsString()` Convenience method, returns a String containing all unresolved references, meant to be used in an error message.
`java.lang.String`	`getUnresolvedReferencesError()` Same as getUnresolvedReferencesError(StringBuffer sb), but just returns a String instead of appending to provided StringBuffer.
`void`	`getUnresolvedReferencesError(java.lang.StringBuffer sb)` Returns a complete error message for all unresolved references this LibraryManager knows about.
`boolean`	`hasReferencedLibraries()` Returns true there are any referenced libraries, false otherwise.
`boolean`	`hasUnresolvedReferences()` Determines if any references to Libraries could not be resolved.
`void`	`initializeReferencedLibraries()` Initializes referenced libraries.
`private boolean`	`isDuplicateRef(LibraryReference ref)`
`private void`	`lookup(LibraryReference inRef)` Lookup Library given a LibraryReference.
`void`	`lookup(LibraryReference[] inRefs)` Lookup Libraries given an Array of LibraryReference Objects.
`void`	`lookupAndAddAutoReferences(Type libType, LibraryConstants.AutoReferrer referencingType)` Looks up auto-reference libraries and adds references to them.
`private void`	`registerLibrary(LibraryReference ref, Library lib)`
`private void`	`registerUnresolvedLibraryRef(LibraryReference ref)`
`void`	`removeReferences()` Un-register the LibraryReferencer with the referenced Libraries.
`void`	`resetUnresolvedReferences()` Resets the unresolved refs this LibraryManager has.
`java.lang.String`	`toString()`
`void`	`writeDiagnosticImage(weblogic.application.utils.XMLWriter writer)` Write information about referenced libraries to passed XMLWriter.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - libReg
```
private static final weblogic.application.internal.library.LibraryRegistry libReg
```
  - libraries
```
private final java.util.List libraries
```
  - resolvedRefs
```
private final java.util.List resolvedRefs
```
  - unresolvedRefs
```
private final java.util.Collection unresolvedRefs
```
  - allRefs
```
private final java.util.Collection allRefs
```
  - libRefs
```
private final java.util.Set libRefs
```
  - referencer
```
private final LibraryReferencer referencer
```
  - partitionName
```
private final java.lang.String partitionName
```
  - autoRefLibs
```
private final java.util.List<LibraryDefinition> autoRefLibs
```
- Constructor Detail
  - LibraryManager
```
public LibraryManager(LibraryReferencer referencer,
                      java.lang.String partitionName)
```
    Initialize with referencer, but without references.
  - LibraryManager
```
public LibraryManager(LibraryReferencer referencer,
                      java.lang.String partitionName,
                      LibraryReference[] refs)
```
    Initialize with Referencer and library references to lookup.
- Method Detail
  - lookup
```
public void lookup(LibraryReference[] inRefs)
```
    Lookup Libraries given an Array of LibraryReference Objects.
    
    Parameters:
    
    inRefs - of LibraryRefBeans. For each LibraryRefBean, this method will attempt to lookup a corresponding Library.
  - lookup
```
private void lookup(LibraryReference inRef)
```
    Lookup Library given a LibraryReference. All lookup methods eventually end up here.
    
    Parameters:
    
    inRef - A LibraryReference for which to lookup a LibraryDefinition.
  - isDuplicateRef
```
private boolean isDuplicateRef(LibraryReference ref)
```
  - getUnreferencedLibraries
```
public Library[] getUnreferencedLibraries()
```
    Returns the Libraries that are not referenced.
    
    Returns:
    
    Library array.
  - hasReferencedLibraries
```
public boolean hasReferencedLibraries()
```
    Returns true there are any referenced libraries, false otherwise.
    
    Returns:
    
    boolean, true if referenced libraries exist.
  - getReferencedLibraries
```
public Library[] getReferencedLibraries()
```
    Returns the Libraries for which the references resolved successfully. The sequence is preorder depth first. Any library overrides all the libraries following it in the list
    
    Specified by:
    
    getReferencedLibraries in interface LibraryProvider
    
    Returns:
    
    Library array.
  - getAutoReferencedLibraries
```
public Library[] getAutoReferencedLibraries()
```
    Returns the auto referenced libraries. The returned list will be empty if lookupAndAddAutoReferences has not been invoked.
    
    Returns:
    
    Library array.
  - getReferencer
```
public LibraryReferencer getReferencer()
```
  - lookupAndAddAutoReferences
```
public void lookupAndAddAutoReferences(Type libType,
                                       LibraryConstants.AutoReferrer referencingType)
```
    Looks up auto-reference libraries and adds references to them. The libraries that are explicitly referred to by the application are not included. Only the latest version of a given library is auto-referenced
    
    Parameters:
    
    libType - the type of libraries to auto reference. In case null is passed, all types of libraries are auto-referenced
    
    referencingType - restrict the auto-references to the ones that state the referencing type as one of the values in auto-ref manifest header
  - initializeReferencedLibraries
```
public void initializeReferencedLibraries()
                                   throws weblogic.application.library.LoggableLibraryProcessingException
```
    Initializes referenced libraries.
    
    Throws:
    
    weblogic.application.library.LoggableLibraryProcessingException
  - getLibraryReferences
```
public LibraryReference[] getLibraryReferences()
```
    Returns the LibraryReferences that resolved successfully. The sequence is preorder depth first. Any library overrides all the libraries following it in the list
    
    Returns:
    
    Library array.
  - getReferencedLibraryRuntimes
```
public LibraryRuntimeMBean[] getReferencedLibraryRuntimes()
```
    Returns the LibraryRuntimes for which the references resolved successfully. Convenience method that can only be called in the container.
    
    Returns:
    
    LibraryRuntimeMBean array.
  - hasUnresolvedReferences
```
public boolean hasUnresolvedReferences()
```
    Determines if any references to Libraries could not be resolved. After instantiating this class, this method should be called to determine if any of the LibraryReferences could not be resoved. Typically any unresolved references should cause an error.
    
    Returns:
    
    boolean.
    
    See Also:
    
    LibraryManager.getUnresolvedReferences(), LibraryManager.getUnresolvedReferencesAsString()
  - getUnresolvedReferences
```
public LibraryReference[] getUnresolvedReferences()
```
    Returns the references for which no Libraries were found.
    
    Returns:
    
    LibraryReference Array, the unresolved references.
  - resetUnresolvedReferences
```
public void resetUnresolvedReferences()
```
    Resets the unresolved refs this LibraryManager has.
  - getUnresolvedReferencesAsString
```
public java.lang.String getUnresolvedReferencesAsString()
```
    Convenience method, returns a String containing all unresolved references, meant to be used in an error message.
    
    Returns:
    
    String, the unresolved references.
  - getUnresolvedReferencesError
```
public void getUnresolvedReferencesError(java.lang.StringBuffer sb)
```
    Returns a complete error message for all unresolved references this LibraryManager knows about. The firt part of the error is specific to the LibraryReferencer. The second just lists all unresolved references.
    
    Parameters:
    
    sb - The StringBuffer to append the message to.
  - getUnresolvedReferencesError
```
public java.lang.String getUnresolvedReferencesError()
```
    Same as getUnresolvedReferencesError(StringBuffer sb), but just returns a String instead of appending to provided StringBuffer.
    
    Returns:
    
    String, the complete error message for unresolved references.
  - registerUnresolvedLibraryRef
```
private void registerUnresolvedLibraryRef(LibraryReference ref)
```
  - registerLibrary
```
private void registerLibrary(LibraryReference ref,
                             Library lib)
```
  - findReferencedLibraries
```
private void findReferencedLibraries(LibraryReference ref)
```
  - addReferences
```
public void addReferences()
```
    Register the LibraryReferencer with the referenced Libraries. This method has to be called by any referencing app, typically at app deployment time.
  - removeReferences
```
public void removeReferences()
```
    Un-register the LibraryReferencer with the referenced Libraries. This method has to be called by any referencing app, typically at app undeployment time. This must be the last method called on this instance.
  - getOptionalPackages
```
public java.io.File[] getOptionalPackages(LibraryReference[] refs)
```
  - writeDiagnosticImage
```
public void writeDiagnosticImage(weblogic.application.utils.XMLWriter writer)
```
    Write information about referenced libraries to passed XMLWriter.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class LibraryManager

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

libReg

libraries

resolvedRefs

unresolvedRefs

allRefs

libRefs

referencer

partitionName

autoRefLibs

Constructor Detail

LibraryManager

LibraryManager

Method Detail

lookup

lookup

isDuplicateRef

getUnreferencedLibraries

hasReferencedLibraries

getReferencedLibraries

getAutoReferencedLibraries

getReferencer

lookupAndAddAutoReferences

initializeReferencedLibraries

getLibraryReferences

getReferencedLibraryRuntimes

hasUnresolvedReferences

getUnresolvedReferences

resetUnresolvedReferences

getUnresolvedReferencesAsString

getUnresolvedReferencesError

getUnresolvedReferencesError

registerUnresolvedLibraryRef

registerLibrary

findReferencedLibraries

addReferences

removeReferences

getOptionalPackages

writeDiagnosticImage

toString