001    /*
002     * Copyright 2006 Stephen J. McConnell.
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
013     * implied.
014     *
015     * See the License for the specific language governing permissions and
016     * limitations under the License.
017     */
018    
019    package net.dpml.transit;
020    
021    import javax.management.MXBean;
022    import javax.management.MBeanException;
023    
024    /** 
025     * Management interface to a resource host.
026     *
027     * @author <a href="http://www.dpml.net">Digital Product Management Library</a>
028     * @version 2.1.1
029     */
030     @MXBean
031    public interface HostManager
032    {
033       /**
034        * Returns the host identifier.
035        * @return the host id
036        * @exception MBeanException if a JMX error occurs
037        */
038        String getID() throws MBeanException;
039        
040       /**
041        * Returns the host priority.
042        * @return the host priority value
043        * @exception MBeanException if a JMX error occurs
044        */
045        int getPriority() throws MBeanException;
046        
047       /**
048        * Returns the host base url.
049        * @return the host url
050        * @exception MBeanException if a JMX error occurs
051        */
052        String getBase() throws MBeanException;
053            
054       /**
055        * Returns the host layout strategy identifier
056        * @return the layout identifier
057        * @exception MBeanException if a JMX error occurs
058        */
059        String getLayoutID() throws MBeanException;
060        
061       /**
062        * Returns the host enabled status.
063        * @return the enabled state
064        * @exception MBeanException if a JMX error occurs
065        */
066        boolean isEnabled() throws MBeanException;
067        
068       /**
069        * Returns the host trusted status.
070        * @return the trusted state
071        * @exception MBeanException if a JMX error occurs
072        */
073        boolean isTrusted() throws MBeanException;
074        
075    }