01: /*
02: * JBoss, Home of Professional Open Source.
03: * Copyright 2006, Red Hat Middleware LLC, and individual contributors
04: * as indicated by the @author tags. See the copyright.txt file in the
05: * distribution for a full listing of individual contributors.
06: *
07: * This is free software; you can redistribute it and/or modify it
08: * under the terms of the GNU Lesser General Public License as
09: * published by the Free Software Foundation; either version 2.1 of
10: * the License, or (at your option) any later version.
11: *
12: * This software is distributed in the hope that it will be useful,
13: * but WITHOUT ANY WARRANTY; without even the implied warranty of
14: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15: * Lesser General Public License for more details.
16: *
17: * You should have received a copy of the GNU Lesser General Public
18: * License along with this software; if not, write to the Free
19: * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
20: * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
21: */
22: package org.jboss.mx.loading;
23:
24: import java.util.Set;
25: import java.net.URL;
26: import java.net.MalformedURLException;
27: import java.text.ParseException;
28:
29: /**
30: * Interface that abstracts the access to different MBean loader parsers
31: * (MLet file parsers, XML based parsers, etc.).
32: *
33: * @see javax.management.loading.MLet
34: * @see org.jboss.mx.loading.MLetParser
35: * @see org.jboss.mx.loading.MBeanLoader
36: * @see org.jboss.mx.loading.XMLMBeanParser
37: *
38: * @author <a href="mailto:juha@jboss.org">Juha Lindfors</a>.
39: * @version $Revision: 57200 $
40: *
41: */
42: public interface MBeanFileParser {
43:
44: /**
45: * Parses a file that describes the configuration of MBeans to load and
46: * instantiate in the MBean server (for example, MLet text file).
47: *
48: * @see org.jboss.mx.loading.MBeanElement
49: *
50: * @param url URL of the file
51: * @return a set of <tt>MBeanElement</tt> objects that contain the required
52: * information to load and register the MBean
53: * @throws ParseException if there was an error parsing the file
54: */
55: Set parseMBeanFile(URL url) throws ParseException;
56:
57: /**
58: * Parses a file that describes the configuration of MBean to load and
59: * instantiate in the MBean server (for example, MLet text file).
60: *
61: * @see org.jboss.mx.loading.MBeanElement
62: *
63: * @param url URL of the file
64: * @return a set of <tt>MBeanElement</tt> objects that contain the required
65: * information to load and register the MBean
66: * @throws ParseException if there was an error parsing the file
67: * @throws MalformedURLException if the URL string was not valid
68: */
69: Set parseMBeanFile(String url) throws ParseException,
70: MalformedURLException;
71:
72: }
|