org.mycore.datamodel.metadata.MCRMetaAccessRule Maven / Gradle / Ivy
/*
* This file is part of *** M y C o R e ***
* See http://www.mycore.de/ for details.
*
* MyCoRe is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* MyCoRe is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with MyCoRe. If not, see
* The constructor of the MCRMetaDefault runs. The permission Attribute
* is set to 'READ'. The condition is set to 'null'.
*/
public MCRMetaAccessRule() {
super();
condition = null;
permission = "READ";
}
/**
* This is the constructor.
* The language element was set. If the value of default_lang is
* null, empty or false en was set. This is not use in other methods
* of this class. The subtag element was set to the value of
* subtag. If the value of subtag
* is null or empty an exception will be throwed. The type element was set to
* the value of type, if it is null, an empty string was set
* to the type element. The condition element was set to the value of
* condition, if it is null, an exception will be throwed.
* @param subtag the name of the subtag
* @param type the optional type string
* @param inherted a value >= 0
* @param permission permission
* @param condition the JDOM Element included the condition tree
* @exception MCRException if the subtag value or condition is null or empty
*/
public MCRMetaAccessRule(String subtag, String type, int inherted, String permission, Element condition)
throws MCRException {
super(subtag, null, type, inherted);
if (condition == null || !condition.getName().equals("condition")) {
throw new MCRException("The condition Element of MCRMetaAccessRule is null.");
}
set(permission, condition);
}
/**
* This method set the permission and the condition.
*
* @param permission the format string, if it is empty 'READ' will be set.
* @param condition
* the JDOM Element included the condition tree
* @exception MCRException
* if the condition is null or empty
*/
public final void set(String permission, Element condition) throws MCRException {
setCondition(condition);
setPermission(permission);
}
/**
* This method set the condition.
*
* @param condition
* the JDOM Element included the condition tree
* @exception MCRException
* if the condition is null or empty
*/
public final void setCondition(Element condition) throws MCRException {
if (condition == null || !condition.getName().equals("condition")) {
throw new MCRException("The condition Element of MCRMetaAccessRule is null.");
}
this.condition = condition.clone();
}
/**
* This method set the permission attribute.
*
* @param permission
* the new permission string.
*/
public final void setPermission(String permission) {
this.permission = permission;
}
/**
* This method get the condition.
*
* @return the condition as JDOM Element
*/
public final Element getCondition() {
return condition;
}
/**
* This method get the permission attribute.
*
* @return the permission attribute
*/
public final String getPermission() {
return permission;
}
/**
* This method read the XML input stream part from a DOM part for the
* metadata of the document.
*
* @param element
* a relevant JDOM element for the metadata
*/
@Override
public void setFromDOM(Element element) {
super.setFromDOM(element);
setCondition(element.getChild("condition"));
setPermission(element.getAttributeValue("permission"));
}
/**
* This method create a XML stream for all data in this class, defined by
* the MyCoRe XML MCRMetaAccessRule definition for the given subtag.
*
* @exception MCRException
* if the content of this class is not valid
* @return a JDOM Element with the XML MCRMetaAccessRule part
*/
@Override
public Element createXML() throws MCRException {
Element elm = super.createXML();
elm.setAttribute("permission", permission);
elm.addContent(condition.clone());
return elm;
}
/**
* Validates this MCRMetaAccessRule. This method throws an exception if:
*
* - the subtag is not null or empty
* - the lang value was supported
* - the inherited value is lower than zero
* - the condition is null
* - the permission is null or empty
*
*
* @throws MCRException the MCRMetaAccessRule is invalid
*/
@Override
public void validate() throws MCRException {
super.validate();
if (condition == null) {
throw new MCRException(getSubTag() + ": condition is null");
}
if (permission == null || permission.length() == 0) {
throw new MCRException(getSubTag() + ": permission is null or empty");
}
}
/**
* This method make a clone of this class.
*/
@Override
public MCRMetaAccessRule clone() {
MCRMetaAccessRule clone = (MCRMetaAccessRule) super.clone();
clone.permission = this.permission;
clone.condition = this.condition.clone();
return clone;
}
/**
* This method put debug data to the logger (for the debug mode).
*/
@Override
public final void debug() {
if (LOGGER.isDebugEnabled()) {
super.debugDefault();
LOGGER.debug("Permission = {}", permission);
LOGGER.debug("Rule = " + "condition");
LOGGER.debug(" ");
}
}
}