All Classes and Interfaces
Class
Description
This is the base implementation for a combined condition.
This class is an abstract for the implementation of command classes for the
MyCoRe commandline system.
This is the base implementation for a condition.
Starting class for all mycore websocket endpoints.
This is the base implementation for a fact.
This is the base implementation for a condition which evaluates or produces facts
Subclasses should call super.parse(xml) to bind the XML element to the condition.
Provides information about a stored version of metadata and allows to
retrieve that version from SVN
Can be used as base class for an
MCRProcessable.Base implementation for an
MCRProgressable.This class is a base implementation of the
MCRAccessInterface.Clears the access cache when an object is updated or deleted.
This class provides helper functions for access cache.
This class provides a set of commands for the org.mycore.access management
which can be used by the command line interface.
MyCoRe-Standard Implementation of the MCRAccessInterface Maps object ids to rules
This class provides a set of commands for the org.mycore.access package which
can be used by the command line interface.
Maps object ids to rules
This class holds all EventHandler methods to manage the access part of the
simple workflow.
The purpose of this interface is to make the choice of the persistence layer
configurable.
This exception holds information about a link condition that did not allow a
certain action to be performed.
This condition combines its child conditions with a boolean AND
A jdom-filter which compares attribute values.
This StartupHandler deploys web resources and register filters/servlets to web container server,
for with
MCR-Auto-Deploy = true marked JARs.This class is a abstract basic class for objects in the MyCoRe Project.
This class contains the basic commands for MyCoRe Command Line and WebCLI.
Implements a basket of entries.
Represents an entry in a basket.
Manages basket objects in the user's current MCRSession.
Manages basket objects in the persistent store.
Resolves entries from a basket, for example to edit the data
in an editor form.
Provides the web front end to manage baskets and their contents.
Builds xml representations of a basket and its entries.
Parses XML representations of baskets and their entries.
Commands to batch add/remove/replace values
like identifiers, categories, tags, flags etc. within XML.
Transforms MCRContent by invoking an external BibUtils command.
This class implements a special kind of BufferedInputStream that blocks
invocations of the read method until the number of bytes that were requested
are fully read from the underlying InputStream.
Class for parsing Boolean clauses
A extension of
ByteArrayOutputStream that allows access to internal buffer.Reads MCRContent from a byte[] array.
Instances of this class can be used as object cache.
Used to define the
HttpHeaders.CACHE_CONTROL header via annotationThis class implements all methods for handling calendars in MyCoRe objects
and data models.
Instances of this class represent a general exception thrown by any part of
the MyCoRe implementation classes.
This implementation checks if the given object belongs to a certain classification entry.
Interface of the Data Access Object for Classifications.
Used for specific JPA queries only.
This fact implementation can store a MyCoRe classification as MCRCategoryID
Link between a category and an object.
Central base implementation for a processable registry.
Abstract class of a concrete cipherimplementation
After checking the permission call the encrypt an decrypt
functionality.
Create Instances of MCRCipher as configured in mycore.properties.
Commands for the classification system.
This class contains helper methods to handle mycore classifications.
Shows details about an exception that occured during command processing
This interface is for conditions that combine other conditions.
A
ResourceBundle.Control that stacks ResourceBundles of MCRComponent.Annotates a public static method as a command that could be executed via
MCRCommandLineInterface.Represents a command understood by the command line interface.
Annotates a class that holds public static methods as commands they could be executed via
MCRCommandLineInterface.The main class implementing the MyCoRe command line interface.
Manages all commands for the Command Line Interface and WebCLI.
Reads the next command entered at the stdin prompt.
Collects statistics on number of invocations and total time needed for each command invoked.
Utilities intended to reduce redundant code when writing variants of CLI commands.
This class abstracts different MyCoRe component types.
This servlet delivers the contents of MCROjects to the client in
container files (see classes extending this servlet).
This interface represents a rule of the fact-based access system.
Servlet to map the properties defined in the init param "Properties" to a JSON object with the property name as key
and the property value as value.
Provides methods to manage and read all configuration properties from the MyCoRe configuration files.
This helper class determines in which directory to look for addition configuration files.
Called by
MCRStartupHandler on start up to setup MCRConfiguration2.Instances of this class represent an exception thrown because of an error in the MyCoRe configuration.
A InputStream from (preferably) property files.
Lookup a value in
MCRConfiguration2.This class replaces the deprecated MCRDefaults interface and provides some
final static fields of common use.
Used to read/write content from any source to any target.
This input stream is used by the MyCoRe filesystem classes to read the
content of a file and import it into the System.
Subclasses of MCRContentTransformer implement different methods
to transform MCRContent.
Creates and returns MCRContentTransformer instances by their ID.
This filter can be used to add a specific Access-Control-Allow-Origin header to a response.
This condition check if the given object has the specified createdby service flag.
Handles CREATE operation on
MCRDerivate.Handles CREATE operation on
MCRObject.First, a check is done if the user is in the submitter role, if the user is the creator of the object and if the
creator ist permitted to perform the requested action in the object's current state (two groups of states, submitted,
and review, are checked).
Java-based implementation of the unix crypt(3) command
Based upon C source code written by Eric Young, eay@psych.uq.oz.au Java
conversion by John F.
This class provides a set of commands for the org.mycore.crypt management
which can be used by the command line interface.
This class provides an URIResolver for encryption and decryption.
Represents the data URL scheme (RFC2397).
Does not really transform content, instead logs the current contents.
Classes can implement this interface if they want to use
the decorator pattern.
The default implementation for
MCRJobStatusListenerManages persistence of MCRObject and MCRDerivate xml metadata.
Encapsulates a
Runnable with in a object that can be fed into a
DelayQueue
Note: This class has a natural ordering that is inconsistent with equals.Handles DELTE operation on
MCRDerivate.Handles DELETE operation on
MCRObject.This class holds all information of a derivate.
Converts the source to an MCRDerivate object and transforms it to JSON using MCRDerivate.createJSON();
Provides static methods that implement commands for the MyCoRe command line
interface.
This servlet transforms and delivers xml content from a derivate.
This servlet is used to display all parents of an mycore object and their
containing derivates.
This class contains commands that may be helpful during development.
This is a NOOP OutputStream that does not write anywhere.
Represents a directory stored in a file collection, which may contain other
files and directories.
Reads MCRContent from a W3C DOM XML document.
Helper class to get
DocumentBuilder instances from a common pool
Extend this class to include dynamic jdom content.
Validates the output of the Editor framework.
MCREntityResolver uses
CatalogResolver for resolving entities or - for compatibility reasons - looks in
classpath to resolve XSD and DTD files.Represents an event that occured in the MyCoRe system.
Pre-defined event types *
Pre-defined event objects *
Category DAO Implementation with Event Handlers
Objects that implement this interface can react when some kind of predefined
event happens in MyCoRe.
Abstract helper class that can be subclassed to implement event handlers more
easily.
Acts as a multiplexer to forward events that are created to all registered
event handlers, in the order that is configured in mycore properties.
Instances of this class represent a general exception thrown by any part of
the MyCoRe implementation classes.
Tries to find the cause of an exception by diving down
those exceptions that wrap other exceptions, recursively.
Represents a collection of XML data to export.
Provides functionality to export content.
This interface is designed to incude external application commands.
A fact is simple piece of information.
This interface can be used to implement a class which can generated new
facts based on the current fact list.
This interface describes a rule (from rules.xml) which can evaluate existing facts
or create new facts if applicable.
base class for XML fact based access system
enabled it with the 2 properties:
MCR.Access.Class=org.mycore.access.facts.MCRFactsAccessSystem
MCR.Access.Strategy.Class=org.mycore.access.facts.MCRFactsAccessSystem
Utility functions for parsing conditions from rules.xml
in fact-based access system.
This class holds all facts which are validated as 'true'
If an identical fact is request again during the rules processing
the result is taken from here and won't be calculated again.
Implementation of the boolean "false" primitive
Represents a file stored in a file collection.
Represents a set of files and directories belonging together, that are stored
in a persistent MCRFileStore.
Reads MCRContent from a local file.
This holds information about file metadata that is stored in derivate xml
Handles category links to files
This servlet delivers the contents of an MCRFilesystemNode to the client
browser.
Stores file collections containing files and directories.
This
MCRStartupHandler.AutoExecutable checks if the FileSystem implementations are available.Encapsulates a
Callable with a mycore session belonging to a specific user and a database transaction.Servlet/Jersey Resource utility class.
Provides the header of the stream that is read.
Helper class to check if EntityManagerFactory is correctly configured.
This class implements the MCRLinkTableInterface.
Handles different HttpSession events.
This is a noop transformer.
Monitors a
HttpClientConnectionManager for expired or idle connections.A class for representing an IP Address, or a range of IP addresses
This fact implementation can store an IP address
Implementation of a (ip xy) clause
This condition checks if the current user has an IP of the specified IP range.
holds info about a specific point in time.
is a helper class for MCRMetaISO8601Date.
A EventHandler which runs as
MCRSystemUserInformation.getJanitorInstance().Reads MCRContent from a JDOM XML document.
Base interface to configure jersey in an mycore application.
Default jersey configuration for mycore.
Default feature for mycore.
Handles jersey web application exceptions.
Entry point for mycore jersey configuration.
Contains some jersey utility methods.
Container class handled by hibernate to store and retrieve job information.
MCRJobAction must be extended to do some work for given MCRJob.The master of all
MCRJobThreads threads.Possible states of the job can be:
MCRJobStatus.NEW
job added to queue
MCRJobStatus.PROCESSING
job currently on processing
MCRJobStatus.FINISHED
job processing is finished
Interface one must implement to get notified about when an
MCRJob has started, finished or failed.A slave thread of
MCRJobMaster.JPA implementation of acceess store to manage access rights
Initializes JPA
EntityManagerFactoryJPA implementation for RuleStore, storing access rules
This class represents a label of a MCRCategory.
Represents a language in the datamodel, independent of the type of code used to encode it.
Represents a type of langauge code, currently the ISO 639-1 and ISO 639-2b and 2t code types.
Detects the language of a given text string by
looking for typical words and word endings and used characters for each language.
Returns MCRLanguage instances.
Resolves languages by code.
Helper class to map xml:lang and lang attributes in XML to MCRLanguage
Does the layout for other MyCoRe servlets by transforming XML input to
various output formats, using XSL stylesheets.
This class acts as a
MCRContentTransformer factory for MCRLayoutService.Xalan extention for navigation.xsl
A
StreamSource that offers a lazy initialization to MCRLazyStreamSource.getInputStream().This class implement the data sructure of the MCRLinkHref table.
This class hold all primary keys of MCRLINKHREF
This class manages all operations of the LinkTables for operations of an object.
This interface is designed to choose the persistence for the link tables.
This class manage all accesses to the link table database.
Same as a
MCRProgressable but can listen to progress change events.Use this class to change log levels of java packages and classes.
Invalidates a session and sends redirect to referring page.
This class provides methods to send emails from within a MyCoRe application.
This eventhandler deals with changes to the maindoc file.
Experimental class to improve performance on delete and import operations.
Builds an MD5 checksum String while content goes through this input stream.
This class implements all method for handling with the MCRMetaAccessRule part
of a metadata object.
This class implements all methods for handling with the MCRMetaAddress part
of a metadata object.
This class implements all method for handling with the MCRMetaBoolean part of
a metadata object.
This class implements all method for handling with the MCRMetaClassification
part of a metadata object.
Delivers persistence operations for
MCRObject and MCRDerivate .This factory creates
MCRMetadataShareAgent instances.Stores XML metadata documents (or optionally any other BLOB data) in a
persistent filesystem structure
For each object type, a store must be defined as follows:
MCR.IFS2.Store.DocPortal_document.Class=org.mycore.datamodel.ifs2.MCRMetadataStore
MCR.IFS2.Store.DocPortal_document.BaseDir=/foo/bar
MCR.IFS2.Store.DocPortal_document.SlotLayout=4-2-2
MCR.IFS2.Store.DocPortal_document.ForceXML=true (which is default)
Provides information about a stored version of metadata and allows to
retrieve that version from SVN
This class implements all method for handling with the MCRMetaDateLangText part
of a metadata object.
This class implements any methods for handling the basic data for all
metadata classes of the metadata objects.
This class is designed to to have a basic class for all metadata.
A Link to a
MCRDerivate.Handles andle which information is present in the
MCRMetaEnrichedLinkID for Derivates.This class implements all methods for handling the MCRMetaHistoryDate
part of a metadata object.
This class describes the structure of pair of language an text.
Entity implementation class for Entity: MCRMetaHistoryItem
This class implements all method for handling the IFS metadata.
This class implements all methods for handling with the
MCRMetaInstitutionName part of a metadata object.
This interface is designed to to have a general description of the common
method set of all metadata classes.
provides support for a restricted range of formats, all of which are valid
ISO 8601 dates and times.
This class implements all method for handling with the MCRMetaLangText part
of a metadata object.
This class implements all method for generic handling with the MCRMetaLink part of a metadata object.
This class implements all method for special handling with the MCRMetaLink
part of a metadata object.
Implements methods to handle MCRMetaNumber fields of a metadata object.
This class implements all methods for handling a name with the
MCRMetaPersonName datamodel.
Stores spatial information for geographic references.
This class implements all method for handling with the MCRMetaLangText part
of a metadata object.
Represents a file, directory or file collection within a file store.
A FilterInputStream that wraps any InputStream to prevent close() is called.
This condition negates its child condition
(boolean NOT)
Only the first child condition will be evaluated.
This class holds all information of a metadata object.
Converts the source to an MCRObject object and transforms it to JSON using MCRObject.createJSON();
Use this class if you want to have a fallback to some default access rules.
This implementation creates an object cache
for MyCoRe objects which are retrieved during the processing of the rules.
Provides static methods that implement commands for the MyCoRe command line interface.
This class implements all methode for handling one derivate data.
This class holds all informations and methods to handle the MyCoRe Object ID.
Converts
MCRObjectID to String.This fact implementation can store a MyCoRe object id
and allows access to the corresponding MyCoRe object.
Use this wrapper if you want a
MCRObjectID as a primary key with name id
in your JPA mapping.Use this class if you want to check against a MCRObjectID.
Helper class to merge mycore objects.
This class implements all methode for handling one object metadata part.
Used to Query a collection of mycore objects.
Allows to query objects using
MCRObjectQuery.This class implements all methods for handling MCRObject service data.
Serves a given MCROBject.
This class implements code for the inheritance of metadata of linked objects
and the linking of derivates onto an MCRObject.
Use this class if you want to have a fallback to some default access rules.
This class contains several helper methods for
MCRObject./**
This condition combines its child conditions with a boolean OR
Base class for every Packer.
Used to run a
MCRPacker inside a MCRJobQueueUsed to pack packages in a specific format, using
MCRJobQueue.Servlet for
MCRPackerManager.Collects parameters used in XSL transformations, by copying them from
MCRConfiguration, from the HTTP and MyCoRe session, from request attributes etc.
Use this class if you want to have a fallback to ancestor access rules.
IFS implementation of the
Path interface.MCRContent implementation that uses Java 7
FileSystem features.Instances of this class represent a general exception thrown by the
persistency layer of the MyCoRe implementation.
Thread safety: Implementation must not ensure that concurrent access is without side effects.
A MCRPool allows thread safe pooling of thread unsafe objects.
This annotation tells which method should be called after the creation
of the object.
Modifies a uploaded file before it will be written to the destination Derivate.
Objects can implement this interface if they are capable of being prioritized.
A supplier with a priority.
Describes an object which can be processed.
Defines a collection of coherent
MCRProcessable.Base event listener interface for adding/removing
MCRProcessable of
MCRProcessableCollection.Base implementation of a processable collection.
A processable executor uses a
ExecutorService to submit
given tasks and returns a MCRProcessableSupplier.Factory and utility methods for
MCRProcessableExecutor.Registry for
MCRProcessable and MCRProcessableCollection.Base event listener interface for adding/removing
MCRProcessableCollection of
an MCRProcessableRegistry.The status of one
MCRProcessable.Base interface to listen to
MCRProcessableStatus changes.A processable supplier combines a
Supplier and a MCRProcessable.Helper class to encapsulate a task within a processable.
Interface to apply a progress to a process.
Base interface to listen to
MCRProgressable changes.Like
Properties but with in-place replacement of properties that want to append a value.The
MCRPropertiesResolver supports substitution of any %reference%
in a String or Property instance.Resolves the property values for the given key or key prefix.
Syntax:
Result for a key prefix:
Syntax:
property:{key-prefix}* or property:{key}
Result for a key prefix:
<!This annotation tells which properties need to be assigned to which field
or method.
Represents a query with its condition and optional parameters
Represents a simple query condition, which consists of a search field,
a value and a comparison operator.
Parses query conditions for use in MCRSearcher.
A MCRReadWriteGuard acts like a
ReadWriteLock but automatically wraps read and write operations accordingly.A
FileVisitor to delete a directory recursivlyThis condition checks if the given id or another fact matches a regular expression.
This class contains EventHandler methods to remove the access part of
MCRObjects.
This condition checks if the user of the current session
is member of the given role.
This serves as an interface to an underlying access controll system.
The purpose of this interface is to make the choice of the persistence layer
configurable.
On first access this class detects all components, that is either MyCoRe components or application modules, that are
available via the current ClassLoader.
An implementation of SecureToken V2 used by "Wowza Streaming Engine".
Filter for
MCRFileNodeServlet that uses MCRSecureTokenV2 to check access to specific file types.An optional interface to MCRContent implementations.
This event handler sets the service flags "createdby" and "modifiedby" for users who created / modified a
MyCoReObject and also added a state service flag using classification defined in
"MCR.Metadata.Service.State.Classification.ID" (default "state") and category defined in
"MCR.Metadata.Service.State.Category.Default" (default "submitted").
This is the superclass of all MyCoRe servlets.
is a shutdown hook for the current
ServletContext.This class simply is a container for objects needed during a Servlet session
like the HttpServletRequest and HttpServeltResponse.
Instances of this class collect information kept during a session like the currently active user, the preferred
language etc.
Opposite of
MCRSessionHookFilter.Manages sessions for a MyCoRe system.
This Class will be stored in the a
HttpSession and can be used to resolve the
MCRSession.Adds MCRSession information to the current
ThreadContext.is a wrapper for shutdown hooks.
Object is cleanly closeable via
close()-call.is a shutdown hook for the current
Runtime.Transforms MyCoRe classification and category objects into SKOS resources
Represents a single sort criteria for sorting query results.
Resets jobs that took to long to perform action.
Initializes classes that implement
MCRStartupHandler.AutoExecutable interface that are defined via
MCR.Startup.Class property.This implementation of a condition
checks if the given MyCoRe object or derivate
has the given state entry in service flags.
The MCRStaticContent annotation marks a resource or method to run without
a MyCoRe transaction, session or access filter.
This servlet displays static *.xml files stored in the web application by sending them to MCRLayoutService.
Stores metadata files or file collections containing files and directories in
a persistent store implemented using a local filesystem.
Represents an XML metadata document that is stored in MCRMetadataStore.
A file or directory really stored by importing it from outside the system.
Reads MCRContent from an input stream.
Helper methods to handle common Stream use cases.
This is a simple implemenation.
Reads MCRContent from a String's text.
This implementation can store a simple String as fact.
A
MCRUserInformation implementation with no roles attached.Uses TAR format to deliver requested content.
Compiles XSL sources, reports compile errors and returns transformer
instances for compiled templates.
Represents an XSL file that will be used in XSL transformation and which is loaded
as a resource.
This class parses and resolve strings which contains variables.
A condition is defined by squared brackets.
As escape character the backslashed is used.
Defines how deep the text is resolved.
A term is a defined part in a text.
Simple class to hold terms and instantiate them.
A simple text, every character is added to the term (except its
a special one).
A variable is surrounded by curly brackets.
Represents a function that accepts one argument and produces a result and throws an Exception.
Uses
MCRXMLHelper.jsonSerialize(org.jdom2.Element) to transform the source (must be XML) to JSON.This class implements an algorithm for topological ordering.
Transforms xml content in pretty, UTF-8 encoded format.
Encapsulates a
Callable with a mycore session and a database transaction.Encapsulates a
Runnable with a mycore session and a database transaction.Transforms MCRContent by using a pipe of multiple transformers.
provides services for internationalization in mycore application.
Simple
FileVisitor that recursive copies a directoryRepresents an operation that accepts two input arguments and returns no result.
Implementation of the boolean "true" primitive
Removes Categories which can not be mapped from a other classification.
Created by chi on 01.02.17.
Handles UPDATE operation on
MCRDerivate.Handles UPDATE operation on
MCRObject.This class does the server-side of uploading files from a client browser,
which runs the upload applet.
handles uploads and store files directly into the IFS.
Common helper class for all services handling file upload.
Uses
mycore.properties to configure MCRUploadViaFormServlet.This servlet handles form based file upload.
Reads XML documents from various URI types.
provides a URI -- Resolver Mapping One can implement this interface to provide additional URI schemes this
MCRURIResolver should handle, too.
Servlet Filter for adding debug information to servlet output.
Instances of MCRUsageException are thrown when the MyCoRe API is used in an
illegal way.
Automatically closes HttpSession of certain user agents.
URI-Resolver, that checks if a MyCoRe object is
worldReadable or worldReadableComplete and certain user and role information
It is used as replacement for Xalan-Java functions in XSLT3 stylesheets.
This condition checks if the current user matches the query string.
Encapsulates informations about the current authenticated user.
Allows to access information on the current user.
This class represent a general set of external methods to support the programming API.
Represents an XML metadata document that is stored in a local filesystem
store and in parallel in a Subversion repository to track and restore
changes.
Stores metadata objects both in a local filesystem structure and in a
Subversion repository.
A virtual node in a file collection, which may be a child node of a container
file type like zip or tar.
Default mycore configuration for websocket endpoints.
Decodes a json string to a gson object.
Interface for Classification Storage Manager
Reads MCRContent from an XML document.
This class provides some static utility methods to deal with XML/DOM
elements, nodes etc.
This class manages all operations of the XMLTables for operations of an
object or derivate.
Provides an adapter to communicate with the configured
MCRXMLMetadataManagerAdapter implementation.Provides an abstract class for persistence managers of MCRObject and MCRDerivate xml
metadata to extend, with methods to perform CRUD operations on object metadata.
Parses XML content and returns it as JDOM document.
Handles errors during XML parsing.
Returns validating or non-validating XML parsers.
Parses XML content using specified
XMLReaderJDOMFactory.provides a cache for reading XML resources.
Builds an absolute XPath expression for a given element or attribute within a JDOM XML structure.
Transforms XML content using a static XSL stylesheet.
Transforms XML content using a static XSL stylesheet.
Lists all *.xsl stylesheets in the web application located in any
WEB-INF/lib/*.jar or WEB-INF/classes/xsl/ or in
MCRConfigurationDir, outputs the
dependencies (import/include) and contained templates.This class implements XSLTransformation functions to be used in all other
MyCoRe packages.
Transforms XML content using a static XSL stylesheet.
Returns a Transformer for a given XSL source, providing caching of
already compiled XSL stylesheets.
Uses ZIP format to deliver requested content.
Converts a
ZonedDateTime to Date for JPA 2.1.This class provides a simple way to dynamically create MyCoRe webpages.