OcflStorageLayoutExtension (OCFL Java Core 1.4.4 API)

All Superinterfaces:

OcflExtension

All Known Implementing Classes:

FlatLayoutExtension, FlatOmitPrefixLayoutExtension, HashedNTupleIdEncapsulationLayoutExtension, HashedNTupleLayoutExtension, NTupleOmitPrefixStorageLayoutExtension
```
public interface OcflStorageLayoutExtension
extends OcflExtension
```
Interface for OCFL storage layout extensions. Storage layout extensions are expected to be used as singletons. They are dynamically loaded when needed, and MUST have a no-arg constructor. The extension is configured by a call to its init(edu.wisc.library.ocfl.core.extension.OcflExtensionConfig) method.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`String`	`getDescription()`
`Class<? extends OcflExtensionConfig>`	`getExtensionConfigClass()`	The class that represents the extensions deserialized configuration.
`void`	`init(OcflExtensionConfig config)`	Configures the extension.
`String`	`mapObjectId(String objectId)`	Maps an object id to its path within the OCFL storage root.

Methods inherited from interface edu.wisc.library.ocfl.core.extension.OcflExtension
getExtensionName

- Method Detail
  - init
```
void init(OcflExtensionConfig config)
```
    Configures the extension. This method must be called before the extension can be used.
    
    Parameters:
    
    config - extension configuration
  - getExtensionConfigClass
```
Class<? extends OcflExtensionConfig> getExtensionConfigClass()
```
    The class that represents the extensions deserialized configuration.
    
    Returns:
    
    configuration class
  - mapObjectId
```
String mapObjectId(String objectId)
```
    Maps an object id to its path within the OCFL storage root.
    
    Parameters:
    
    objectId - the object id
    
    Returns:
    
    the path to the object root relative to the OCFL storage root
  - getDescription
```
String getDescription()
```
    Returns:
    
    the description text that should be used in ocfl_layout.json