001/*
002 * Copyright 2015 DuraSpace, Inc.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016package org.fcrepo.migration;
017
018import javax.xml.stream.XMLStreamException;
019
020/**
021 * A class that encapsulates an object for processing.  This class represents a single object and
022 * exposes methods to query basic information about it and then to process it with an arbitrary
023 * StreamingFedoraObjectHandler.
024 * @author mdurbin
025 */
026public interface FedoraObjectProcessor extends AutoCloseable {
027
028    /**
029     * get object information.
030     * @return the object info
031     */
032    public ObjectInfo getObjectInfo();
033
034    /**
035     * process the object.
036     * @param handler the handler
037     * @throws XMLStreamException xml stream exception
038     */
039    public void processObject(StreamingFedoraObjectHandler handler) throws XMLStreamException;
040
041    /**
042     * Close resources associated to the processor
043     */
044    void close();
045
046}