001/* ***** BEGIN LICENSE BLOCK *****
002 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
003 *
004 * The contents of this file are subject to the Mozilla Public License Version
005 * 1.1 (the "License"); you may not use this file except in compliance with
006 * the License. You may obtain a copy of the License at
007 * http://www.mozilla.org/MPL/
008 *
009 * Software distributed under the License is distributed on an "AS IS" basis,
010 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
011 * for the specific language governing rights and limitations under the
012 * License.
013 *
014 * The Original Code is part of dcm4che, an implementation of DICOM(TM) in
015 * Java(TM), hosted at https://github.com/gunterze/dcm4che.
016 *
017 * The Initial Developer of the Original Code is
018 * Agfa Healthcare.
019 * Portions created by the Initial Developer are Copyright (C) 2011
020 * the Initial Developer. All Rights Reserved.
021 *
022 * Contributor(s):
023 * See @authors listed below
024 *
025 * Alternatively, the contents of this file may be used under the terms of
026 * either the GNU General Public License Version 2 or later (the "GPL"), or
027 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
028 * in which case the provisions of the GPL or the LGPL are applicable instead
029 * of those above. If you wish to allow use of your version of this file only
030 * under the terms of either the GPL or the LGPL, and not to allow others to
031 * use your version of this file under the terms of the MPL, indicate your
032 * decision by deleting the provisions above and replace them with the notice
033 * and other provisions required by the GPL or the LGPL. If you do not delete
034 * the provisions above, a recipient may use your version of this file under
035 * the terms of any one of the MPL, the GPL or the LGPL.
036 *
037 * ***** END LICENSE BLOCK ***** */
038
039package org.dcm4che3.conf.api.internal;
040
041import org.dcm4che3.conf.api.DicomConfigOptions;
042import org.dcm4che3.conf.api.DicomConfiguration;
043import org.dcm4che3.conf.core.api.ConfigurationException;
044import org.dcm4che3.conf.core.api.TypeSafeConfiguration;
045import org.dcm4che3.conf.dicom.DicomConfigurationRoot;
046import org.dcm4che3.net.Device;
047import org.dcm4che3.net.DeviceInfo;
048
049import java.io.Closeable;
050
051/**
052 * This interface is for internal use. For any vendor/external integration purposes, please use DicomConfiguration.
053 *
054 * @author Gunter Zeilinger <gunterze@gmail.com>
055 *
056 */
057public interface ExtendedDicomConfiguration extends DicomConfiguration, Closeable {
058
059    TypeSafeConfiguration<DicomConfigurationRoot> getTypeSafeConfiguration();
060
061    /**
062     * Allows to use extended options
063     */
064    Device findDevice(String name, DicomConfigOptions options) throws ConfigurationException;
065
066    /**
067     * Indicates whether the configuration backend is initialized
068     * @return
069     * @throws ConfigurationException
070     */
071    boolean configurationExists() throws ConfigurationException;
072
073    @Deprecated
074    boolean registerAETitle(String aet) throws ConfigurationException;
075    @Deprecated
076    void unregisterAETitle(String aet) throws ConfigurationException;
077
078    /**
079     * Query for Devices with specified attributes.
080     * 
081     * @param keys
082     *            Device attributes which shall match or <code>null</code> to
083     *            get information for all configured Devices
084     * @return array of <code>DeviceInfo</code> objects for configured Devices
085     *         with matching attributes
086     * @throws ConfigurationException
087     */
088    DeviceInfo[] listDeviceInfos(DeviceInfo keys) throws ConfigurationException;
089
090    void close();
091
092    boolean purgeConfiguration() throws ConfigurationException;
093}