fair

package

Go to main page

Versions in this module

v2

v2.0.15

Aug 19, 2025

v2.0.14

May 28, 2025

v2.0.13

Nov 29, 2024

Changes in this version

+ func ARKBeautifier(ark string) string

v2.0.12

Nov 25, 2024

Changes in this version

type ResolveResultType

+ const ResolveResultTypeApplicationYAML

v2.0.11

Nov 25, 2024

v2.0.10

Nov 25, 2024

Changes in this version

+ var ErrInvalidIdentifier = errors.New("invalid identifier")

+ func ArkParts(pid string) (naan, qualifier, component, variant, inflection string, err error)

+ type ARKConfig struct

+ NAAN string

+ Prefix string

+ Shoulder string

+ type ARKService struct

+ func NewARKService(mr *MultiResolver, config *ARKConfig, logger zLogger.ZLogger) (*ARKService, error)

+ func (srv *ARKService) AddPlugin(repository string, plugin Plugin)

+ func (srv *ARKService) CreatePID(fair *Fair, item *ItemData) (string, error)

+ func (srv *ARKService) Resolve(pid string) (string, ResolveResultType, error)

+ func (srv *ARKService) Type() dataciteModel.RelatedIdentifierType

+ func (srv *ARKService) Unify(ark string) (string, error)

+ type ArkPluginResultType uint

+ const ARKPluginCannotHandle

+ const ARKPluginData

+ const ARKPluginRedirect

+ type DataciteConfig struct

+ Api string

+ Password string

+ Prefix string

+ User string

+ type DataciteService struct

+ func NewDataciteService(mr *MultiResolver, config DataciteConfig, logger zLogger.ZLogger) (*DataciteService, error)

+ func (srv *DataciteService) CreatePID(fair *Fair, item *ItemData) (string, error)

+ func (srv *DataciteService) Resolve(pid string) (string, ResolveResultType, error)

+ func (srv *DataciteService) Type() dataciteModel.RelatedIdentifierType

type Fair

+ func (f *Fair) GetDB() *pgxpool.Pool

+ func (f *Fair) NextCounter(name string) (int64, error)

+ func (f *Fair) Resolve(pid string) (data string, resultType ResolveResultType, err error)

+ type HandleConfig struct

+ Addr string

+ ID string

+ JWTAlg string

+ JWTKey string

+ Prefix string

+ ServiceName string

+ SkipCertVerify bool

+ type HandleService struct

+ func NewHandleService(mr *MultiResolver, config *HandleConfig, logger zLogger.ZLogger) (*HandleService, error)

+ func (srv *HandleService) CreatePID(fair *Fair, item *ItemData) (string, error)

+ func (srv *HandleService) Resolve(pid string) (string, ResolveResultType, error)

+ func (srv *HandleService) Type() dataciteModel.RelatedIdentifierType

type ItemData

+ Partition string

+ URL string

+ type MultiResolver struct

+ func NewResolver(part *Partition, logger zLogger.ZLogger) (*MultiResolver, error)

+ func (mr *MultiResolver) AddResolver(resolver Resolver)

+ func (mr *MultiResolver) CreateAll(part *Partition, t dataciteModel.RelatedIdentifierType) error

+ func (mr *MultiResolver) CreatePID(uuid string, part *Partition, ...) (string, error)

+ func (mr *MultiResolver) GetPartition() *Partition

+ func (mr *MultiResolver) InitPIDTable() error

+ func (mr *MultiResolver) Resolve(pid string) (data string, resultType ResolveResultType, err error)

+ func (mr *MultiResolver) StorePID(uuid string, identifierType dataciteModel.RelatedIdentifierType, ...) error

+ type OAIConfig struct

+ AdminEmail []string

+ Delimiter string

+ PageSize int64

+ RepositoryName string

+ ResumptionTokenTimeout time.Duration

+ SampleIdentifier string

+ Scheme string

type Partition

+ OAI *OAIConfig

+ func (p *Partition) AddResolver(mr *MultiResolver)

+ func (p *Partition) CreatePID(uuid string, identifierType dataciteModel.RelatedIdentifierType) (string, error)

+ func (p *Partition) GetFair() *Fair

+ func (p *Partition) GetMultiResolver() *MultiResolver

+ func (p *Partition) RedirURL(uuid string) string

+ func (p *Partition) Resolve(pid string) (string, ResolveResultType, error)

+ type Plugin interface

+ Handle func(fair *Fair, pid string, item *ItemData) (*PluginResult, error)

+ type PluginResult struct

+ Data []byte

+ Mime string

+ Type ArkPluginResultType

+ type ResolveResultType uint32

+ const ResolveResultTypeApplicationJSON

+ const ResolveResultTypeApplicationXML

+ const ResolveResultTypeRedirect

+ const ResolveResultTypeTextHTML

+ const ResolveResultTypeTextPlain

+ const ResolveResultTypeUnknown

+ type Resolver interface

+ CreatePID func(fair *Fair, item *ItemData) (string, error)

+ Type func() dataciteModel.RelatedIdentifierType

+ type ResolverResolve interface

+ Resolve func(pid string) (string, ResolveResultType, error)

type Source

+ Repository string

v2.0.9

Mar 1, 2024

v2.0.8

Mar 1, 2024

v2.0.7

Mar 1, 2024

Changes in this version

type Archive

+ CreationDate time.Time

+ Description string

+ LastVersion int64

+ Name string

type DataStatus

+ const DataStatusDeletedMeta

type Fair

+ func (f *Fair) GetArchive(part *Partition, name string) (*Archive, error)

v2.0.6

Dec 10, 2021

Changes in this version

+ func UniqString(arr []string) []string

+ type Archive struct

+ type ArchiveItem struct

+ NewFiles []string

type Fair

+ func (f *Fair) AddArchive(part *Partition, name, description string) error

+ func (f *Fair) AddArchiveItem(part *Partition, archive string, item *ItemData) error

+ func (f *Fair) GetArchiveItems(part *Partition, archive string, delta bool, fn func(item *ArchiveItem) error) error

v2.0.5

Nov 18, 2021

Changes in this version

type Fair

+ func (f *Fair) SetSource(src *Source) error

v2.0.4

Nov 17, 2021

Changes in this version

type Fair

+ func (f *Fair) GetOriginalData(partitionName, uuid string) ([]byte, string, error)

+ func (f *Fair) SetOriginalData(partitionName, uuid string, format string, data []byte) error

v2.0.3

Nov 5, 2021

v2.0.2

Nov 3, 2021

Changes in this version

+ var DataAccessReverse = map[string]DataAccess

+ var DataStatusReverse = map[string]DataStatus

+ type DataAccess string

+ const DataAccessClosed

+ const DataAccessClosedData

+ const DataAccessOpenAccess

+ const DataAccessPublic

+ type DataStatus string

+ const DataStatusActive

+ const DataStatusDeleted

+ const DataStatusDisabled

+ type Fair struct

+ func NewFair(db *sql.DB, dbSchema string, handle *hcClient.HandleCreatorClient, ...) (*Fair, error)

+ func (f *Fair) AbortUpdate(partitionName string, source string) error

+ func (f *Fair) AddPartition(p *Partition)

+ func (f *Fair) CreateDOI(partitionName, uuidStr, targetUrl string) (*datacite.API, error)

+ func (f *Fair) CreateItem(partitionName string, data *ItemData) (*ItemData, error)

+ func (f *Fair) DeleteItem(partitionName, uuidStr string) error

+ func (f *Fair) EndUpdate(partitionName string, source string) error

+ func (f *Fair) GetItem(partitionName, uuidStr string) (*ItemData, error)

+ func (f *Fair) GetItemSource(partitionName string, sourceid int64, signature string) (*ItemData, error)

+ func (f *Fair) GetItemsDatestamp(partitionName string, datestamp, until time.Time, access []DataAccess, ...) error

+ func (f *Fair) GetItemsSeq(partitionName string, seq int64, until time.Time, access []DataAccess, ...) error

+ func (f *Fair) GetMinimumDatestamp(partitionName string) (time.Time, error)

+ func (f *Fair) GetPartition(name string) (*Partition, error)

+ func (f *Fair) GetPartitions() map[string]*Partition

+ func (f *Fair) GetSets(partitionName string) (map[string]string, error)

+ func (f *Fair) GetSourceById(id int64, partitionName string) (*Source, error)

+ func (f *Fair) GetSourceByName(name string, partitionName string) (*Source, error)

+ func (f *Fair) GetSourceByOAIDomain(name string) (*Source, error)

+ func (f *Fair) LoadSources() error

+ func (f *Fair) RefreshSearch() error

+ func (f *Fair) Search(partitionName string, dtr *datatable.Request) ([]map[string]string, int64, int64, error)

+ func (f *Fair) StartUpdate(partitionName string, source string) error

+ type ItemData struct

+ Access DataAccess

+ Catalog []string

+ Datestamp time.Time

+ Identifier []string

+ Metadata myfair.Core

+ Seq int64

+ Set []string

+ Signature string

+ Source string

+ Status DataStatus

+ UUID string

+ type Partition struct

+ AddrExt string

+ Description string

+ Domain string

+ HandleID string

+ HandlePrefix string

+ JWTAlg []string

+ JWTKey string

+ Name string

+ OAIAdminEmail []string

+ OAIDelimiter string

+ OAIPagesize int64

+ OAIRepositoryName string

+ OAISampleIdentifier string

+ OAIScheme string

+ ResumptionTokenTimeout time.Duration

+ func NewPartition(Name, AddrExt, Domain, HandlePrefix, OAIRepositoryName string, ...) (*Partition, error)

+ type Source struct

+ Description string

+ DetailURL string

+ ID int64

+ Name string

+ OAIDomain string

+ Partition string

+ type SourceData struct

+ Source string

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL