se.kb.oai.pmh.ErrorResponseException.java Source code

Introduction

Here is the source code for se.kb.oai.pmh.ErrorResponseException.java

Source

/*
 * Copyright 2008 National Library of Sweden Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License. You may obtain a copy of the License at
 * http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS
 * OF ANY KIND, either express or implied. See the License for the specific language governing permissions and
 * limitations under the License.
 */

package se.kb.oai.pmh;

import org.dom4j.Element;

import se.kb.oai.OAIException;
import de.fhg.iais.commons.constants.Serial;

/**
 * Exception that is thrown when the response from the OAI-PMH server has <code>&lt;error&gt;</code> elements
 * in it. There are eight different error codes that can be returned:
 * <ul>
 * <li>badArgument
 * <li>badResumptionToken
 * <li>badVerb
 * <li>cannotDisseminateFormat
 * <li>idDoesNotExist
 * <li>noRecordsMatch
 * <li>noMetadataFormats
 * <li>noSetHierarchy
 * </ul>
 * 
 * @author Oskar Grenholm, National Library of Sweden
 */
public class ErrorResponseException extends OAIException {

    private static final long serialVersionUID = Serial.GLOBAL_DEFAULT_SERIAL_VERSION_UID;

    private static final String ERROR_CODE_ATTR = "code";

    private final String code;
    private final String message;

    /**
     * Creates an <code>ErrorResponseException</code> with the returned error code and error message.
     * 
     * @param error the <code>&lt;error&gt;</code> element
     */
    public ErrorResponseException(Element error) {
        super();
        this.code = error.attributeValue(ERROR_CODE_ATTR);
        this.message = error.getTextTrim();
    }

    /**
     * Get the error code.
     * 
     * @return the error code
     */
    public String getCode() {
        return this.code;
    }

    /**
     * Get the error message.
     * 
     * @return the error message
     */
    @Override
    public String getMessage() {
        return this.message;
    }
}