Package edu.wisc.library.ocfl.api

Class OcflConfig

java.lang.Object

edu.wisc.library.ocfl.api.OcflConfig

public class OcflConfig
extends Object

Contains OCFL related configuration options. All values are defaulted.

Constructor Summary

Constructors

Constructor	Description
OcflConfig()
OcflConfig(OcflConfig original)

Method Summary

Modifier and Type	Method	Description
String	getDefaultContentDirectory()
DigestAlgorithm	getDefaultDigestAlgorithm()
int	getDefaultZeroPaddingWidth()
OcflVersion	getOcflVersion()
OcflConfig	setDefaultContentDirectory(String defaultContentDirectory)	Set the default content directory to use when creating new inventories.
OcflConfig	setDefaultDigestAlgorithm(DigestAlgorithm defaultDigestAlgorithm)	Set the default digest algorithm to use when creating new inventories.
OcflConfig	setDefaultZeroPaddingWidth(int defaultZeroPaddingWidth)	Set the default zero padding width to use in version numbers in newly created objects.
OcflConfig	setOcflVersion(OcflVersion ocflVersion)	Set the default OCFL version to use when creating new inventories.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

OcflConfig

public OcflConfig()

OcflConfig

public OcflConfig(OcflConfig original)

Method Detail

setOcflVersion

public OcflConfig setOcflVersion(OcflVersion ocflVersion)

Set the default OCFL version to use when creating new inventories.

Parameters:

ocflVersion - ocfl version

Returns:

config

getOcflVersion

public OcflVersion getOcflVersion()

setDefaultDigestAlgorithm

public OcflConfig setDefaultDigestAlgorithm(DigestAlgorithm defaultDigestAlgorithm)

Set the default digest algorithm to use when creating new inventories. MUST be sha-256 or sha-512. Default: sha-512

Parameters:

defaultDigestAlgorithm - digest algorithm

Returns:

config

getDefaultDigestAlgorithm

public DigestAlgorithm getDefaultDigestAlgorithm()

setDefaultContentDirectory

public OcflConfig setDefaultContentDirectory(String defaultContentDirectory)

Set the default content directory to use when creating new inventories. MUST NOT contain / or \. Default: contents

Parameters:

defaultContentDirectory - content directory

Returns:

config

getDefaultContentDirectory

public String getDefaultContentDirectory()

getDefaultZeroPaddingWidth

public int getDefaultZeroPaddingWidth()

setDefaultZeroPaddingWidth

public OcflConfig setDefaultZeroPaddingWidth(int defaultZeroPaddingWidth)

Set the default zero padding width to use in version numbers in newly created objects. Default: 0

Parameters:

defaultZeroPaddingWidth - zero padding width

Returns:

config

toString

public String toString()

Overrides:

toString in class Object