Autonomous sub-portion of a ClassWorld.
This class most closed maps to the ClassLoader
57 | * role from Java and in facts can provide a ClassLoader
58 | * view of itself using {@link #getClassLoader}.
ClassWorld errors.
50 | *
51 | * @author bob mcwhirter
52 | */
53 | @Deprecated
54 | public class ClassWorldException extends Exception {
55 | // ------------------------------------------------------------
56 | // Instance members
57 | // ------------------------------------------------------------
58 |
59 | /**
60 | * The world.
61 | */
62 | private ClassWorld world;
63 |
64 | // ------------------------------------------------------------
65 | // Constructors
66 | // ------------------------------------------------------------
67 |
68 | /**
69 | * Construct.
70 | *
71 | * @param world The world.
72 | */
73 | public ClassWorldException(final ClassWorld world) {
74 | this.world = world;
75 | }
76 |
77 | /**
78 | * Construct.
79 | *
80 | * @param world The world.
81 | * @param msg The detail message.
82 | */
83 | public ClassWorldException(final ClassWorld world, final String msg) {
84 | super(msg);
85 | this.world = world;
86 | }
87 |
88 | // ------------------------------------------------------------
89 | // Instance methods
90 | // ------------------------------------------------------------
91 |
92 | /**
93 | * Retrieve the world.
94 | *
95 | * @return The world.
96 | */
97 | public ClassWorld getWorld() {
98 | return this.world;
99 | }
100 | }
101 |
--------------------------------------------------------------------------------
/src/main/java/org/codehaus/classworlds/ClassWorldReverseAdapter.java:
--------------------------------------------------------------------------------
1 | package org.codehaus.classworlds;
2 |
3 | /*
4 | * Copyright 2001-2010 Codehaus Foundation.
5 | *
6 | * Licensed under the Apache License, Version 2.0 (the "License");
7 | * you may not use this file except in compliance with the License.
8 | * You may obtain a copy of the License at
9 | *
10 | * http://www.apache.org/licenses/LICENSE-2.0
11 | *
12 | * Unless required by applicable law or agreed to in writing, software
13 | * distributed under the License is distributed on an "AS IS" BASIS,
14 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 | * See the License for the specific language governing permissions and
16 | * limitations under the License.
17 | */
18 |
19 | import java.util.Collection;
20 | import java.util.HashMap;
21 | import java.util.Vector;
22 |
23 | /**
24 | * A reverse adapter for ClassWorlds
25 | *
26 | * @author Andrew Williams
27 | */
28 | @Deprecated
29 | public class ClassWorldReverseAdapter extends org.codehaus.plexus.classworlds.ClassWorld {
30 | private static HashMap instances = new HashMap();
31 |
32 | public static ClassWorldReverseAdapter getInstance(ClassWorld oldWorld) {
33 | if (instances.containsKey(oldWorld)) return (ClassWorldReverseAdapter) instances.get(oldWorld);
34 |
35 | ClassWorldReverseAdapter adapter = new ClassWorldReverseAdapter(oldWorld);
36 | instances.put(oldWorld, adapter);
37 |
38 | return adapter;
39 | }
40 |
41 | private ClassWorld world;
42 |
43 | private ClassWorldReverseAdapter(ClassWorld newWorld) {
44 | super();
45 | this.world = newWorld;
46 | }
47 |
48 | public org.codehaus.plexus.classworlds.realm.ClassRealm newRealm(String id)
49 | throws org.codehaus.plexus.classworlds.realm.DuplicateRealmException {
50 | try {
51 | return ClassRealmReverseAdapter.getInstance(world.newRealm(id));
52 | } catch (DuplicateRealmException e) {
53 | throw new org.codehaus.plexus.classworlds.realm.DuplicateRealmException(this, e.getId());
54 | }
55 | }
56 |
57 | public org.codehaus.plexus.classworlds.realm.ClassRealm newRealm(String id, ClassLoader classLoader)
58 | throws org.codehaus.plexus.classworlds.realm.DuplicateRealmException {
59 | try {
60 | return ClassRealmReverseAdapter.getInstance(world.newRealm(id, classLoader));
61 | } catch (DuplicateRealmException e) {
62 | throw new org.codehaus.plexus.classworlds.realm.DuplicateRealmException(this, e.getId());
63 | }
64 | }
65 |
66 | public void disposeRealm(String id) throws org.codehaus.plexus.classworlds.realm.NoSuchRealmException {
67 | try {
68 | world.disposeRealm(id);
69 | } catch (NoSuchRealmException e) {
70 | throw new org.codehaus.plexus.classworlds.realm.NoSuchRealmException(this, e.getId());
71 | }
72 | }
73 |
74 | public org.codehaus.plexus.classworlds.realm.ClassRealm getRealm(String id)
75 | throws org.codehaus.plexus.classworlds.realm.NoSuchRealmException {
76 | try {
77 | return ClassRealmReverseAdapter.getInstance(world.getRealm(id));
78 | } catch (NoSuchRealmException e) {
79 | throw new org.codehaus.plexus.classworlds.realm.NoSuchRealmException(this, e.getId());
80 | }
81 | }
82 |
83 | public Collection getRealms() {
84 | Collection realms = world.getRealms();
85 | Vector ret = new Vector();
86 |
87 | for (Object o : realms) {
88 | ClassRealm realm = (ClassRealm) o;
89 | ret.add(ClassRealmReverseAdapter.getInstance(realm));
90 | }
91 |
92 | return ret;
93 | }
94 | }
95 |
--------------------------------------------------------------------------------
/src/main/java/org/codehaus/classworlds/ConfigurationException.java:
--------------------------------------------------------------------------------
1 | package org.codehaus.classworlds;
2 |
3 | /*
4 |
5 | Copyright 2002 (C) The Werken Company. All Rights Reserved.
6 |
7 | Redistribution and use of this software and associated documentation
8 | ("Software"), with or without modification, are permitted provided
9 | that the following conditions are met:
10 |
11 | 1. Redistributions of source code must retain copyright
12 | statements and notices. Redistributions must also contain a
13 | copy of this document.
14 |
15 | 2. Redistributions in binary form must reproduce the
16 | above copyright notice, this list of conditions and the
17 | following disclaimer in the documentation and/or other
18 | materials provided with the distribution.
19 |
20 | 3. The name "classworlds" must not be used to endorse or promote
21 | products derived from this Software without prior written
22 | permission of The Werken Company. For written permission,
23 | please contact bob@werken.com.
24 |
25 | 4. Products derived from this Software may not be called "classworlds"
26 | nor may "classworlds" appear in their names without prior written
27 | permission of The Werken Company. "classworlds" is a registered
28 | trademark of The Werken Company.
29 |
30 | 5. Due credit should be given to The Werken Company.
31 | (http://classworlds.werken.com/).
32 |
33 | THIS SOFTWARE IS PROVIDED BY THE WERKEN COMPANY AND CONTRIBUTORS
34 | ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT
35 | NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
36 | FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
37 | THE WERKEN COMPANY OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
38 | INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
39 | (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
40 | SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
41 | HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
42 | STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
43 | ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
44 | OF THE POSSIBILITY OF SUCH DAMAGE.
45 |
46 | */
47 |
48 | /**
49 | * Indicates an error during Launcher configuration.
50 | *
51 | * @author bob mcwhirter
52 | */
53 | @Deprecated
54 | public class ConfigurationException extends Exception {
55 | /**
56 | * Construct.
57 | *
58 | * @param msg The message.
59 | */
60 | public ConfigurationException(String msg) {
61 | super(msg);
62 | }
63 |
64 | /**
65 | * Construct.
66 | *
67 | * @param msg The message.
68 | * @param lineNo The number of configuraton line where the problem occured.
69 | * @param line The configuration line where the problem occured.
70 | */
71 | public ConfigurationException(String msg, int lineNo, String line) {
72 | super(msg + " (" + lineNo + "): " + line);
73 | }
74 | }
75 |
--------------------------------------------------------------------------------
/src/main/java/org/codehaus/classworlds/Configurator.java:
--------------------------------------------------------------------------------
1 | package org.codehaus.classworlds;
2 |
3 | /*
4 | * Copyright 2001-2010 Codehaus Foundation.
5 | *
6 | * Licensed under the Apache License, Version 2.0 (the "License");
7 | * you may not use this file except in compliance with the License.
8 | * You may obtain a copy of the License at
9 | *
10 | * http://www.apache.org/licenses/LICENSE-2.0
11 | *
12 | * Unless required by applicable law or agreed to in writing, software
13 | * distributed under the License is distributed on an "AS IS" BASIS,
14 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 | * See the License for the specific language governing permissions and
16 | * limitations under the License.
17 | */
18 |
19 | import java.io.FileNotFoundException;
20 | import java.io.IOException;
21 | import java.io.InputStream;
22 | import java.net.MalformedURLException;
23 |
24 | /**
25 | * A compatibility wrapper for org.codehaus.plexus.classworlds.launcher.Configurator
26 | * provided for legacy code
27 | *
28 | * @author Andrew Williams
29 | */
30 | @Deprecated
31 | public class Configurator {
32 | private ConfiguratorAdapter config;
33 |
34 | /** Construct.
35 | *
36 | * @param launcher The launcher to configure.
37 | */
38 | public Configurator(Launcher launcher) {
39 | config = ConfiguratorAdapter.getInstance(
40 | new org.codehaus.plexus.classworlds.launcher.Configurator(launcher), launcher);
41 | }
42 |
43 | /** Construct.
44 | *
45 | * @param world The classWorld to configure.
46 | */
47 | public Configurator(ClassWorld world) {
48 | config = ConfiguratorAdapter.getInstance(
49 | new org.codehaus.plexus.classworlds.launcher.Configurator(ClassWorldReverseAdapter.getInstance(world)),
50 | world);
51 | }
52 |
53 | /** set world.
54 | * this setter is provided so you can use the same configurator to configure several "worlds"
55 | *
56 | * @param world The classWorld to configure.
57 | */
58 | public void setClassWorld(ClassWorld world) {
59 | config.setClassWorld(world);
60 | }
61 |
62 | /**
63 | * Configure from a file.
64 | *
65 | * @param is The config input stream
66 | * @throws IOException If an error occurs reading the config file.
67 | * @throws MalformedURLException If the config file contains invalid URLs.
68 | * @throws ConfigurationException If the config file is corrupt.
69 | * @throws DuplicateRealmException If the config file defines two realms with the same id.
70 | * @throws NoSuchRealmException If the config file defines a main entry point in
71 | * a non-existent realm.
72 | */
73 | public void configure(InputStream is)
74 | throws IOException, MalformedURLException, ConfigurationException, DuplicateRealmException,
75 | NoSuchRealmException {
76 | config.configureAdapter(is);
77 | }
78 |
79 | /**
80 | * Associate parent realms with their children.
81 | */
82 | protected void associateRealms() {
83 | config.associateRealms();
84 | }
85 |
86 | /**
87 | * Load a glob into the specified classloader.
88 | *
89 | * @param line The path configuration line.
90 | * @param realm The realm to populate
91 | * @throws MalformedURLException If the line does not represent
92 | * a valid path element.
93 | * @throws FileNotFoundException If the line does not represent
94 | * a valid path element in the filesystem.
95 | */
96 | protected void loadGlob(String line, ClassRealm realm) throws MalformedURLException, FileNotFoundException {
97 | loadGlob(line, realm, false);
98 | }
99 |
100 | /**
101 | * Load a glob into the specified classloader.
102 | *
103 | * @param line The path configuration line.
104 | * @param realm The realm to populate
105 | * @param optionally Whether the path is optional or required
106 | * @throws MalformedURLException If the line does not represent
107 | * a valid path element.
108 | * @throws FileNotFoundException If the line does not represent
109 | * a valid path element in the filesystem.
110 | */
111 | protected void loadGlob(String line, ClassRealm realm, boolean optionally)
112 | throws MalformedURLException, FileNotFoundException {
113 | config.loadGlob(line, realm, optionally);
114 | }
115 |
116 | /**
117 | * Filter a string for system properties.
118 | *
119 | * @param text The text to filter.
120 | * @return The filtered text.
121 | * @throws ConfigurationException If the property does not
122 | * exist or if there is a syntax error.
123 | */
124 | protected String filter(String text) throws ConfigurationException {
125 | return config.filter(text);
126 | }
127 | }
128 |
--------------------------------------------------------------------------------
/src/main/java/org/codehaus/classworlds/ConfiguratorAdapter.java:
--------------------------------------------------------------------------------
1 | package org.codehaus.classworlds;
2 |
3 | /*
4 | * Copyright 2001-2010 Codehaus Foundation.
5 | *
6 | * Licensed under the Apache License, Version 2.0 (the "License");
7 | * you may not use this file except in compliance with the License.
8 | * You may obtain a copy of the License at
9 | *
10 | * http://www.apache.org/licenses/LICENSE-2.0
11 | *
12 | * Unless required by applicable law or agreed to in writing, software
13 | * distributed under the License is distributed on an "AS IS" BASIS,
14 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 | * See the License for the specific language governing permissions and
16 | * limitations under the License.
17 | */
18 |
19 | import java.io.IOException;
20 | import java.io.InputStream;
21 | import java.net.MalformedURLException;
22 |
23 | /**
24 | */
25 | @Deprecated
26 | public class ConfiguratorAdapter extends Configurator {
27 |
28 | public static ConfiguratorAdapter getInstance(
29 | org.codehaus.plexus.classworlds.launcher.Configurator newConfig, Launcher launcher) {
30 | ConfiguratorAdapter adapter = new ConfiguratorAdapter(newConfig, launcher);
31 |
32 | return adapter;
33 | }
34 |
35 | public static ConfiguratorAdapter getInstance(
36 | org.codehaus.plexus.classworlds.launcher.Configurator newConfig, ClassWorld world) {
37 | ConfiguratorAdapter adapter = new ConfiguratorAdapter(newConfig, world);
38 |
39 | return adapter;
40 | }
41 |
42 | private org.codehaus.plexus.classworlds.launcher.Configurator config;
43 |
44 | private ConfiguratorAdapter(org.codehaus.plexus.classworlds.launcher.Configurator config, Launcher launcher) {
45 | super(launcher);
46 | this.config = config;
47 | }
48 |
49 | private ConfiguratorAdapter(org.codehaus.plexus.classworlds.launcher.Configurator config, ClassWorld world) {
50 | super(world);
51 | this.config = config;
52 | }
53 |
54 | public void associateRealms() {
55 | config.associateRealms();
56 | }
57 |
58 | public void configureAdapter(InputStream is)
59 | throws IOException, MalformedURLException, ConfigurationException, DuplicateRealmException,
60 | NoSuchRealmException {
61 | try {
62 | config.configure(is);
63 | } catch (org.codehaus.plexus.classworlds.launcher.ConfigurationException e) {
64 | throw new ConfigurationException(e.getMessage());
65 | } catch (org.codehaus.plexus.classworlds.realm.DuplicateRealmException e) {
66 | throw new DuplicateRealmException(ClassWorldAdapter.getInstance(e.getWorld()), e.getId());
67 | } catch (org.codehaus.plexus.classworlds.realm.NoSuchRealmException e) {
68 | throw new NoSuchRealmException(ClassWorldAdapter.getInstance(e.getWorld()), e.getId());
69 | }
70 | }
71 | }
72 |
--------------------------------------------------------------------------------
/src/main/java/org/codehaus/classworlds/DefaultClassRealm.java:
--------------------------------------------------------------------------------
1 | package org.codehaus.classworlds;
2 |
3 | /*
4 | * Copyright 2001-2010 Codehaus Foundation.
5 | *
6 | * Licensed under the Apache License, Version 2.0 (the "License");
7 | * you may not use this file except in compliance with the License.
8 | * You may obtain a copy of the License at
9 | *
10 | * http://www.apache.org/licenses/LICENSE-2.0
11 | *
12 | * Unless required by applicable law or agreed to in writing, software
13 | * distributed under the License is distributed on an "AS IS" BASIS,
14 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 | * See the License for the specific language governing permissions and
16 | * limitations under the License.
17 | */
18 |
19 | /*
20 | * A compatibility wrapper for org.codehaus.plexus.classworlds.realm.ClassRealm
21 | * provided for legacy code
22 | *
23 | * @author Andrew Williams
24 | */
25 |
26 | import java.io.File;
27 | import java.io.IOException;
28 | import java.io.InputStream;
29 | import java.net.URL;
30 | import java.util.Enumeration;
31 |
32 | @Deprecated
33 | public class DefaultClassRealm implements ClassRealm {
34 | private ClassRealmAdapter adapter;
35 |
36 | public DefaultClassRealm(ClassWorld world, String id) {
37 | this(world, id, null);
38 | }
39 |
40 | public DefaultClassRealm(ClassWorld world, String id, ClassLoader foreignClassLoader) {
41 | this.adapter = ClassRealmAdapter.getInstance(new org.codehaus.plexus.classworlds.realm.ClassRealm(
42 | ClassWorldReverseAdapter.getInstance(world), id, foreignClassLoader));
43 | }
44 |
45 | public URL[] getConstituents() {
46 | return adapter.getConstituents();
47 | }
48 |
49 | public ClassRealm getParent() {
50 | return adapter.getParentRealm();
51 | }
52 |
53 | public void setParent(ClassRealm parent) {
54 | adapter.setParent(parent);
55 | }
56 |
57 | public String getId() {
58 | return adapter.getId();
59 | }
60 |
61 | public ClassWorld getWorld() {
62 | return adapter.getWorld();
63 | }
64 |
65 | public void importFrom(String realmId, String packageName) throws NoSuchRealmException {
66 | adapter.importFrom(realmId, packageName);
67 | }
68 |
69 | public void addConstituent(URL constituent) {
70 | adapter.addConstituent(constituent);
71 | }
72 |
73 | /**
74 | * Adds a byte[] class definition as a constituent for locating classes.
75 | * Currently uses BytesURLStreamHandler to hold a reference of the byte[] in memory.
76 | * This ensures we have a unifed URL resource model for all constituents.
77 | * The code to cache to disk is commented out - maybe a property to choose which method?
78 | *
79 | * @param constituent class name
80 | * @param b the class definition as a byte[]
81 | * @throws ClassNotFoundException when class couldn't be loaded
82 | */
83 | public void addConstituent(String constituent, byte[] b) throws ClassNotFoundException {
84 | try {
85 | File path, file;
86 | if (constituent.lastIndexOf('.') != -1) {
87 | path = new File("byteclass/"
88 | + constituent
89 | .substring(0, constituent.lastIndexOf('.') + 1)
90 | .replace('.', File.separatorChar));
91 |
92 | file = new File(path, constituent.substring(constituent.lastIndexOf('.') + 1) + ".class");
93 | } else {
94 | path = new File("byteclass/");
95 |
96 | file = new File(path, constituent + ".class");
97 | }
98 |
99 | addConstituent(new URL(null, file.toURI().toURL().toExternalForm(), new BytesURLStreamHandler(b)));
100 | } catch (java.io.IOException e) {
101 | throw new ClassNotFoundException("Couldn't load byte stream.", e);
102 | }
103 | }
104 |
105 | public ClassRealm locateSourceRealm(String classname) {
106 | return adapter.locateSourceRealm(classname);
107 | }
108 |
109 | public ClassLoader getClassLoader() {
110 | return adapter.getClassLoader();
111 | }
112 |
113 | public ClassRealm createChildRealm(String id) throws DuplicateRealmException {
114 | return adapter.createChildRealm(id);
115 | }
116 |
117 | // ----------------------------------------------------------------------
118 | // ClassLoader API
119 | // ----------------------------------------------------------------------
120 |
121 | public Class loadClass(String name) throws ClassNotFoundException {
122 | return adapter.loadClass(name);
123 | }
124 |
125 | public URL getResource(String name) {
126 | return adapter.getResource(name);
127 | }
128 |
129 | public InputStream getResourceAsStream(String name) {
130 | return adapter.getResourceAsStream(name);
131 | }
132 |
133 | public Enumeration findResources(String name) throws IOException {
134 | return adapter.findResources(name);
135 | }
136 |
137 | public void display() {
138 | adapter.display();
139 | }
140 | }
141 |
--------------------------------------------------------------------------------
/src/main/java/org/codehaus/classworlds/DuplicateRealmException.java:
--------------------------------------------------------------------------------
1 | package org.codehaus.classworlds;
2 |
3 | /*
4 |
5 | Copyright 2002 (C) The Werken Company. All Rights Reserved.
6 |
7 | Redistribution and use of this software and associated documentation
8 | ("Software"), with or without modification, are permitted provided
9 | that the following conditions are met:
10 |
11 | 1. Redistributions of source code must retain copyright
12 | statements and notices. Redistributions must also contain a
13 | copy of this document.
14 |
15 | 2. Redistributions in binary form must reproduce the
16 | above copyright notice, this list of conditions and the
17 | following disclaimer in the documentation and/or other
18 | materials provided with the distribution.
19 |
20 | 3. The name "classworlds" must not be used to endorse or promote
21 | products derived from this Software without prior written
22 | permission of The Werken Company. For written permission,
23 | please contact bob@werken.com.
24 |
25 | 4. Products derived from this Software may not be called "classworlds"
26 | nor may "classworlds" appear in their names without prior written
27 | permission of The Werken Company. "classworlds" is a registered
28 | trademark of The Werken Company.
29 |
30 | 5. Due credit should be given to The Werken Company.
31 | (http://classworlds.werken.com/).
32 |
33 | THIS SOFTWARE IS PROVIDED BY THE WERKEN COMPANY AND CONTRIBUTORS
34 | ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT
35 | NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
36 | FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
37 | THE WERKEN COMPANY OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
38 | INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
39 | (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
40 | SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
41 | HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
42 | STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
43 | ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
44 | OF THE POSSIBILITY OF SUCH DAMAGE.
45 |
46 | */
47 |
48 | /**
49 | * Indicates an attempt to add a ClassRealm to a
50 | * ClassWorld with a duplicate id.
51 | *
52 | * @author bob mcwhirter
53 | */
54 | @Deprecated
55 | public class DuplicateRealmException extends ClassWorldException {
56 | // ------------------------------------------------------------
57 | // Instance members
58 | // ------------------------------------------------------------
59 |
60 | /**
61 | * The realm id.
62 | */
63 | private String id;
64 |
65 | // ------------------------------------------------------------
66 | // Constructors
67 | // ------------------------------------------------------------
68 |
69 | /**
70 | * Construct.
71 | *
72 | * @param world The world.
73 | * @param id The realm id.
74 | */
75 | public DuplicateRealmException(ClassWorld world, String id) {
76 | super(world, id);
77 | this.id = id;
78 | }
79 |
80 | // ------------------------------------------------------------
81 | // Instance methods
82 | // ------------------------------------------------------------
83 |
84 | /**
85 | * Retrieve the duplicate realm id.
86 | *
87 | * @return The id.
88 | */
89 | public String getId() {
90 | return this.id;
91 | }
92 | }
93 |
--------------------------------------------------------------------------------
/src/main/java/org/codehaus/classworlds/Launcher.java:
--------------------------------------------------------------------------------
1 | package org.codehaus.classworlds;
2 |
3 | /*
4 | * Copyright 2001-2010 Codehaus Foundation.
5 | *
6 | * Licensed under the Apache License, Version 2.0 (the "License");
7 | * you may not use this file except in compliance with the License.
8 | * You may obtain a copy of the License at
9 | *
10 | * http://www.apache.org/licenses/LICENSE-2.0
11 | *
12 | * Unless required by applicable law or agreed to in writing, software
13 | * distributed under the License is distributed on an "AS IS" BASIS,
14 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 | * See the License for the specific language governing permissions and
16 | * limitations under the License.
17 | */
18 |
19 | /**
20 | * A compatibility wrapper for org.codehaus.plexus.classworlds.launcher.Launcher
21 | * provided for legacy code
22 | *
23 | * @author Andrew Williams
24 | */
25 | @Deprecated
26 | public class Launcher extends org.codehaus.plexus.classworlds.launcher.Launcher {
27 | public Launcher() {}
28 |
29 | // ------------------------------------------------------------
30 | // Class methods
31 | // ------------------------------------------------------------
32 |
33 | /**
34 | * Launch the launcher from the command line.
35 | * Will exit using System.exit with an exit code of 0 for success, 100 if there was an unknown exception,
36 | * or some other code for an application error.
37 | *
38 | * @param args The application command-line arguments.
39 | */
40 | public static void main(String[] args) {
41 | org.codehaus.plexus.classworlds.launcher.Launcher.main(args);
42 | }
43 |
44 | /**
45 | * Launch the launcher.
46 | *
47 | * @param args The application command-line arguments.
48 | * @return an integer exit code
49 | * @throws Exception If an error occurs.
50 | */
51 | public static int mainWithExitCode(String[] args) throws Exception {
52 | return org.codehaus.plexus.classworlds.launcher.Launcher.mainWithExitCode(args);
53 | }
54 | }
55 |
--------------------------------------------------------------------------------
/src/main/java/org/codehaus/classworlds/NoSuchRealmException.java:
--------------------------------------------------------------------------------
1 | package org.codehaus.classworlds;
2 |
3 | /*
4 |
5 | Copyright 2002 (C) The Werken Company. All Rights Reserved.
6 |
7 | Redistribution and use of this software and associated documentation
8 | ("Software"), with or without modification, are permitted provided
9 | that the following conditions are met:
10 |
11 | 1. Redistributions of source code must retain copyright
12 | statements and notices. Redistributions must also contain a
13 | copy of this document.
14 |
15 | 2. Redistributions in binary form must reproduce the
16 | above copyright notice, this list of conditions and the
17 | following disclaimer in the documentation and/or other
18 | materials provided with the distribution.
19 |
20 | 3. The name "classworlds" must not be used to endorse or promote
21 | products derived from this Software without prior written
22 | permission of The Werken Company. For written permission,
23 | please contact bob@werken.com.
24 |
25 | 4. Products derived from this Software may not be called "classworlds"
26 | nor may "classworlds" appear in their names without prior written
27 | permission of The Werken Company. "classworlds" is a registered
28 | trademark of The Werken Company.
29 |
30 | 5. Due credit should be given to The Werken Company.
31 | (http://classworlds.werken.com/).
32 |
33 | THIS SOFTWARE IS PROVIDED BY THE WERKEN COMPANY AND CONTRIBUTORS
34 | ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT
35 | NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
36 | FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
37 | THE WERKEN COMPANY OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
38 | INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
39 | (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
40 | SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
41 | HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
42 | STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
43 | ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
44 | OF THE POSSIBILITY OF SUCH DAMAGE.
45 |
46 | */
47 |
48 | /**
49 | * Indicates an attempt to retrieve a ClassRealm from a
50 | * ClassWorld with an invalid id.
51 | *
52 | * @author bob mcwhirter
53 | */
54 | @Deprecated
55 | public class NoSuchRealmException extends ClassWorldException {
56 | // ------------------------------------------------------------
57 | // Instance members
58 | // ------------------------------------------------------------
59 |
60 | /**
61 | * The realm id.
62 | */
63 | private String id;
64 |
65 | // ------------------------------------------------------------
66 | // Constructors
67 | // ------------------------------------------------------------
68 |
69 | /**
70 | * Construct.
71 | *
72 | * @param world The world.
73 | * @param id The realm id.
74 | */
75 | public NoSuchRealmException(ClassWorld world, String id) {
76 | super(world, id);
77 | this.id = id;
78 | }
79 |
80 | // ------------------------------------------------------------
81 | // Instance methods
82 | // ------------------------------------------------------------
83 |
84 | /**
85 | * Retrieve the invalid realm id.
86 | *
87 | * @return The id.
88 | */
89 | public String getId() {
90 | return this.id;
91 | }
92 | }
93 |
--------------------------------------------------------------------------------
/src/main/java/org/codehaus/plexus/classworlds/ClassWorld.java:
--------------------------------------------------------------------------------
1 | package org.codehaus.plexus.classworlds;
2 |
3 | /*
4 | * Copyright 2001-2006 Codehaus Foundation.
5 | *
6 | * Licensed under the Apache License, Version 2.0 (the "License");
7 | * you may not use this file except in compliance with the License.
8 | * You may obtain a copy of the License at
9 | *
10 | * http://www.apache.org/licenses/LICENSE-2.0
11 | *
12 | * Unless required by applicable law or agreed to in writing, software
13 | * distributed under the License is distributed on an "AS IS" BASIS,
14 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 | * See the License for the specific language governing permissions and
16 | * limitations under the License.
17 | */
18 |
19 | import java.io.Closeable;
20 | import java.io.IOException;
21 | import java.util.ArrayList;
22 | import java.util.Collection;
23 | import java.util.Collections;
24 | import java.util.LinkedHashMap;
25 | import java.util.List;
26 | import java.util.Map;
27 | import java.util.function.Predicate;
28 |
29 | import org.codehaus.plexus.classworlds.realm.ClassRealm;
30 | import org.codehaus.plexus.classworlds.realm.DuplicateRealmException;
31 | import org.codehaus.plexus.classworlds.realm.FilteredClassRealm;
32 | import org.codehaus.plexus.classworlds.realm.NoSuchRealmException;
33 |
34 | /**
35 | * A collection of ClassRealms, indexed by id.
36 | *
37 | * @author bob mcwhirter
38 | */
39 | public class ClassWorld implements Closeable {
40 | private Mapnull.
70 | * @param classLoader The base class loader for this realm, may be null to use the bootstrap class
71 | * loader.
72 | * @param filter a predicate to apply to each resource name to determine if it should be loaded through this class loader
73 | * @return the created class realm
74 | * @throws DuplicateRealmException in case a realm with the given id does already exist
75 | * @since 2.7.0
76 | * @see FilteredClassRealm
77 | */
78 | public synchronized ClassRealm newRealm(String id, ClassLoader classLoader, PredicateClassWorld errors.
21 | *
22 | * @author bob mcwhirter
23 | */
24 | public class ClassWorldException extends Exception {
25 | // ------------------------------------------------------------
26 | // Instance members
27 | // ------------------------------------------------------------
28 |
29 | /**
30 | * The world.
31 | */
32 | private ClassWorld world;
33 |
34 | // ------------------------------------------------------------
35 | // Constructors
36 | // ------------------------------------------------------------
37 |
38 | /**
39 | * Construct.
40 | *
41 | * @param world The world.
42 | */
43 | public ClassWorldException(final ClassWorld world) {
44 | this.world = world;
45 | }
46 |
47 | /**
48 | * Construct.
49 | *
50 | * @param world The world.
51 | * @param msg The detail message.
52 | */
53 | public ClassWorldException(final ClassWorld world, final String msg) {
54 | super(msg);
55 | this.world = world;
56 | }
57 |
58 | // ------------------------------------------------------------
59 | // Instance methods
60 | // ------------------------------------------------------------
61 |
62 | /**
63 | * Retrieve the world.
64 | *
65 | * @return The world.
66 | */
67 | public ClassWorld getWorld() {
68 | return this.world;
69 | }
70 | }
71 |
--------------------------------------------------------------------------------
/src/main/java/org/codehaus/plexus/classworlds/ClassWorldListener.java:
--------------------------------------------------------------------------------
1 | package org.codehaus.plexus.classworlds;
2 |
3 | /*
4 | * Copyright 2001-2006 Codehaus Foundation.
5 | *
6 | * Licensed under the Apache License, Version 2.0 (the "License");
7 | * you may not use this file except in compliance with the License.
8 | * You may obtain a copy of the License at
9 | *
10 | * http://www.apache.org/licenses/LICENSE-2.0
11 | *
12 | * Unless required by applicable law or agreed to in writing, software
13 | * distributed under the License is distributed on an "AS IS" BASIS,
14 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 | * See the License for the specific language governing permissions and
16 | * limitations under the License.
17 | */
18 |
19 | import org.codehaus.plexus.classworlds.realm.ClassRealm;
20 |
21 | public interface ClassWorldListener {
22 | void realmCreated(ClassRealm realm);
23 |
24 | void realmDisposed(ClassRealm realm);
25 | }
26 |
--------------------------------------------------------------------------------
/src/main/java/org/codehaus/plexus/classworlds/UrlUtils.java:
--------------------------------------------------------------------------------
1 | package org.codehaus.plexus.classworlds;
2 |
3 | /*
4 | * Copyright 2001-2006 Codehaus Foundation.
5 | *
6 | * Licensed under the Apache License, Version 2.0 (the "License");
7 | * you may not use this file except in compliance with the License.
8 | * You may obtain a copy of the License at
9 | *
10 | * http://www.apache.org/licenses/LICENSE-2.0
11 | *
12 | * Unless required by applicable law or agreed to in writing, software
13 | * distributed under the License is distributed on an "AS IS" BASIS,
14 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 | * See the License for the specific language governing permissions and
16 | * limitations under the License.
17 | */
18 |
19 | import java.net.URL;
20 | import java.net.URLClassLoader;
21 | import java.util.Arrays;
22 | import java.util.HashSet;
23 | import java.util.Set;
24 |
25 | /**
26 | * @author Jason van Zyl
27 | */
28 | public class UrlUtils {
29 | public static String normalizeUrlPath(String name) {
30 | if (name.startsWith("/")) {
31 | name = name.substring(1);
32 | }
33 |
34 | // Looking for org/codehaus/werkflow/personality/basic/../common/core-idioms.xml
35 | // | i |
36 | // +-------+ remove
37 | //
38 | int i = name.indexOf("/..");
39 |
40 | // Can't be at the beginning because we have no root to refer to so
41 | // we start at 1.
42 | if (i > 0) {
43 | int j = name.lastIndexOf("/", i - 1);
44 |
45 | if (j >= 0) {
46 | name = name.substring(0, j) + name.substring(i + 3);
47 | }
48 | }
49 |
50 | return name;
51 | }
52 |
53 | public static SetLauncher configuration.
21 | *
22 | * @author bob mcwhirter
23 | */
24 | public class ConfigurationException extends Exception {
25 | /**
26 | * Construct.
27 | *
28 | * @param msg The message.
29 | */
30 | public ConfigurationException(String msg) {
31 | super(msg);
32 | }
33 |
34 | /**
35 | * Construct.
36 | *
37 | * @param msg The message.
38 | * @param lineNo The number of configuraton line where the problem occured.
39 | * @param line The configuration line where the problem occured.
40 | */
41 | public ConfigurationException(String msg, int lineNo, String line) {
42 | super(msg + " (" + lineNo + "): " + line);
43 | }
44 |
45 | protected ConfigurationException(Exception cause) {
46 | super(cause);
47 | }
48 | }
49 |
--------------------------------------------------------------------------------
/src/main/java/org/codehaus/plexus/classworlds/launcher/ConfigurationHandler.java:
--------------------------------------------------------------------------------
1 | package org.codehaus.plexus.classworlds.launcher;
2 |
3 | /*
4 | * Copyright 2001-2006 Codehaus Foundation.
5 | *
6 | * Licensed under the Apache License, Version 2.0 (the "License");
7 | * you may not use this file except in compliance with the License.
8 | * You may obtain a copy of the License at
9 | *
10 | * http://www.apache.org/licenses/LICENSE-2.0
11 | *
12 | * Unless required by applicable law or agreed to in writing, software
13 | * distributed under the License is distributed on an "AS IS" BASIS,
14 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 | * See the License for the specific language governing permissions and
16 | * limitations under the License.
17 | */
18 |
19 | import java.io.File;
20 | import java.net.URL;
21 |
22 | import org.codehaus.plexus.classworlds.realm.DuplicateRealmException;
23 | import org.codehaus.plexus.classworlds.realm.NoSuchRealmException;
24 |
25 | /**
26 | * Receive notification of the logical content of launcher configuration, independently from parsing.
27 | *
28 | * @author Igor Fedorenko
29 | */
30 | public interface ConfigurationHandler {
31 |
32 | /**
33 | * Define the main class name
34 | * @param mainClassName the main class name
35 | * @param mainRealmName the main realm from which the main class is loaded
36 | */
37 | void setAppMain(String mainClassName, String mainRealmName);
38 |
39 | /**
40 | * Define a new realm
41 | * @param realmName the new realm name
42 | * @throws DuplicateRealmException when realm with name already exists
43 | */
44 | void addRealm(String realmName) throws DuplicateRealmException;
45 |
46 | /**
47 | * Add an import specification from a realm
48 | * @param realmName the realm name
49 | * @param importSpec the import specification
50 | * @throws NoSuchRealmException if realm doesn't exist
51 | */
52 | void addImportFrom(String realmName, String importSpec) throws NoSuchRealmException;
53 |
54 | /**
55 | * Add a file to the realm
56 | * @param file the file to load content from
57 | */
58 | void addLoadFile(File file);
59 |
60 | /**
61 | * Add an URL to the realm
62 | * @param url the url to load content from
63 | */
64 | void addLoadURL(URL url);
65 | }
66 |
--------------------------------------------------------------------------------
/src/main/java/org/codehaus/plexus/classworlds/launcher/Configurator.java:
--------------------------------------------------------------------------------
1 | package org.codehaus.plexus.classworlds.launcher;
2 |
3 | /*
4 | * Copyright 2001-2006 Codehaus Foundation.
5 | *
6 | * Licensed under the Apache License, Version 2.0 (the "License");
7 | * you may not use this file except in compliance with the License.
8 | * You may obtain a copy of the License at
9 | *
10 | * http://www.apache.org/licenses/LICENSE-2.0
11 | *
12 | * Unless required by applicable law or agreed to in writing, software
13 | * distributed under the License is distributed on an "AS IS" BASIS,
14 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 | * See the License for the specific language governing permissions and
16 | * limitations under the License.
17 | */
18 |
19 | import java.io.File;
20 | import java.io.IOException;
21 | import java.io.InputStream;
22 | import java.net.MalformedURLException;
23 | import java.net.URL;
24 | import java.util.ArrayList;
25 | import java.util.HashMap;
26 | import java.util.List;
27 | import java.util.Map;
28 |
29 | import org.codehaus.plexus.classworlds.ClassWorld;
30 | import org.codehaus.plexus.classworlds.realm.ClassRealm;
31 | import org.codehaus.plexus.classworlds.realm.DuplicateRealmException;
32 | import org.codehaus.plexus.classworlds.realm.NoSuchRealmException;
33 |
34 | /**
35 | * Launcher configurator.
36 | *
37 | * @author bob mcwhirter
38 | * @author Jason van Zyl
39 | */
40 | public class Configurator implements ConfigurationHandler {
41 | /**
42 | * The launcher to configure.
43 | */
44 | private Launcher launcher;
45 |
46 | private ClassWorld world;
47 |
48 | /**
49 | * Processed Realms.
50 | */
51 | private MapClassRealm to a
24 | * ClassWorld with a duplicate id.
25 | *
26 | * @author bob mcwhirter
27 | */
28 | public class DuplicateRealmException extends ClassWorldException {
29 | // ------------------------------------------------------------
30 | // Instance members
31 | // ------------------------------------------------------------
32 |
33 | /**
34 | * The realm id.
35 | */
36 | private String id;
37 |
38 | // ------------------------------------------------------------
39 | // Constructors
40 | // ------------------------------------------------------------
41 |
42 | /**
43 | * Construct.
44 | *
45 | * @param world The world.
46 | * @param id The realm id.
47 | */
48 | public DuplicateRealmException(ClassWorld world, String id) {
49 | super(world, id);
50 | this.id = id;
51 | }
52 |
53 | // ------------------------------------------------------------
54 | // Instance methods
55 | // ------------------------------------------------------------
56 |
57 | /**
58 | * Retrieve the duplicate realm id.
59 | *
60 | * @return The id.
61 | */
62 | public String getId() {
63 | return this.id;
64 | }
65 | }
66 |
--------------------------------------------------------------------------------
/src/main/java/org/codehaus/plexus/classworlds/realm/Entry.java:
--------------------------------------------------------------------------------
1 | package org.codehaus.plexus.classworlds.realm;
2 |
3 | /*
4 | * Copyright 2001-2006 Codehaus Foundation.
5 | *
6 | * Licensed under the Apache License, Version 2.0 (the "License");
7 | * you may not use this file except in compliance with the License.
8 | * You may obtain a copy of the License at
9 | *
10 | * http://www.apache.org/licenses/LICENSE-2.0
11 | *
12 | * Unless required by applicable law or agreed to in writing, software
13 | * distributed under the License is distributed on an "AS IS" BASIS,
14 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 | * See the License for the specific language governing permissions and
16 | * limitations under the License.
17 | */
18 |
19 | /**
20 | * Import description entry.
21 | *
22 | * @author bob mcwhirter
23 | */
24 | class Entry implements Comparablenull.
63 | * @return true if this entry matches the
64 | * classname, otherwise false.
65 | */
66 | boolean matches(String name) {
67 | String pkg = getPackageName();
68 |
69 | if (pkg.endsWith(".*")) {
70 | String pkgName;
71 |
72 | if (name.indexOf('/') < 0) {
73 | // a binary class name, e.g. java.lang.Object
74 |
75 | int index = name.lastIndexOf('.');
76 | pkgName = (index < 0) ? "" : name.substring(0, index);
77 | } else {
78 | // a resource name, e.g. java/lang/Object.class
79 |
80 | int index = name.lastIndexOf('/');
81 | pkgName = (index < 0) ? "" : name.substring(0, index).replace('/', '.');
82 | }
83 |
84 | return pkgName.length() == pkg.length() - 2 && pkg.regionMatches(0, pkgName, 0, pkgName.length());
85 | } else if (pkg.length() > 0) {
86 | if (name.indexOf('/') < 0) {
87 | // a binary class name, e.g. java.lang.Object
88 |
89 | if (name.startsWith(pkg)) {
90 | if (name.length() == pkg.length()) {
91 | // exact match of class name
92 | return true;
93 | } else if (name.charAt(pkg.length()) == '.') {
94 | // prefix match of package name
95 | return true;
96 | } else if (name.charAt(pkg.length()) == '$') {
97 | // prefix match of enclosing type
98 | return true;
99 | }
100 | }
101 | } else {
102 | // a resource name, e.g. java/lang/Object.class
103 |
104 | if (name.equals(pkg)) {
105 | // exact match of resource name
106 | return true;
107 | }
108 |
109 | pkg = pkg.replace('.', '/');
110 |
111 | if (name.startsWith(pkg) && name.length() > pkg.length()) {
112 | if (name.charAt(pkg.length()) == '/') {
113 | // prefix match of package directory
114 | return true;
115 | } else if (name.charAt(pkg.length()) == '$') {
116 | // prefix match of nested class file
117 | return true;
118 | } else if (name.length() == pkg.length() + 6 && name.endsWith(".class")) {
119 | // exact match of class file
120 | return true;
121 | }
122 | }
123 | }
124 |
125 | return false;
126 | } else {
127 | return true;
128 | }
129 | }
130 |
131 | // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
132 | // java.lang.Comparable
133 | // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
134 |
135 | /**
136 | * Compare this entry to another for relative ordering.
137 | *
138 | *
139 | * The natural ordering of Entry objects is reverse-alphabetical
140 | * based upon package name.
141 | *
142 | *
143 | * @param that The object to compare.
144 | * @return -1 if this object sorts before that object, 0
145 | * if they are equal, or 1 if this object sorts
146 | * after that object.
147 | */
148 | public int compareTo(Entry that) {
149 | // We are reverse sorting this list, so that
150 | // we get longer matches first:
151 | //
152 | // com.werken.foo.bar
153 | // com.werken.foo
154 | // com.werken
155 |
156 | return -(getPackageName().compareTo(that.getPackageName()));
157 | }
158 |
159 | // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
160 | // java.lang.Object
161 | // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
162 |
163 | /**
164 | * Test this entry for equality to another.
165 | *
166 | *
167 | * Consistent with {@link #compareTo}, this method tests
168 | * for equality purely on the package name.
169 | *
170 | *
171 | * @param thatObj The object to compare
172 | * @return true if the two objects are
173 | * semantically equivalent, otherwise false.
174 | */
175 | public boolean equals(Object thatObj) {
176 | Entry that = (Entry) thatObj;
177 |
178 | return getPackageName().equals(that.getPackageName());
179 | }
180 |
181 | /**
182 | *
183 | * Consistent with {@link #equals}, this method creates a hashCode
184 | * based on the packagename.
185 | *
186 | */
187 | public int hashCode() {
188 | return getPackageName().hashCode();
189 | }
190 |
191 | public String toString() {
192 | return "Entry[import " + getPackageName() + " from realm " + getClassLoader() + "]";
193 | }
194 | }
195 |
--------------------------------------------------------------------------------
/src/main/java/org/codehaus/plexus/classworlds/realm/FilteredClassRealm.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Licensed to the Apache Software Foundation (ASF) under one
3 | * or more contributor license agreements. See the NOTICE file
4 | * distributed with this work for additional information
5 | * regarding copyright ownership. The ASF licenses this file
6 | * to you under the Apache License, Version 2.0 (the
7 | * "License"); you may not use this file except in compliance
8 | * with the License. You may obtain a copy of the License at
9 | *
10 | * http://www.apache.org/licenses/LICENSE-2.0
11 | *
12 | * Unless required by applicable law or agreed to in writing,
13 | * software distributed under the License is distributed on an
14 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 | * KIND, either express or implied. See the License for the
16 | * specific language governing permissions and limitations
17 | * under the License.
18 | */
19 | package org.codehaus.plexus.classworlds.realm;
20 |
21 | import java.io.IOException;
22 | import java.net.URL;
23 | import java.util.Collections;
24 | import java.util.Enumeration;
25 | import java.util.function.Predicate;
26 |
27 | import org.codehaus.plexus.classworlds.ClassWorld;
28 |
29 | /**
30 | * Similar to {@link ClassRealm} but only exposing some resources of the underlying URL.
31 | * Only supposed to be called from {@link ClassWorld}.
32 | */
33 | public class FilteredClassRealm extends ClassRealm {
34 | private final Predicatenull.
41 | * @param id The identifier for this realm, must not be null.
42 | * @param baseClassLoader The base class loader for this realm, may be null to use the bootstrap class
43 | * loader.
44 | */
45 | public FilteredClassRealm(PredicateClassRealm from a
24 | * ClassWorld with an invalid id.
25 | *
26 | * @author bob mcwhirter
27 | */
28 | public class NoSuchRealmException extends ClassWorldException {
29 | // ------------------------------------------------------------
30 | // Instance members
31 | // ------------------------------------------------------------
32 |
33 | /**
34 | * The realm id.
35 | */
36 | private String id;
37 |
38 | // ------------------------------------------------------------
39 | // Constructors
40 | // ------------------------------------------------------------
41 |
42 | /**
43 | * Construct.
44 | *
45 | * @param world The world.
46 | * @param id The realm id.
47 | */
48 | public NoSuchRealmException(ClassWorld world, String id) {
49 | super(world, id);
50 | this.id = id;
51 | }
52 |
53 | // ------------------------------------------------------------
54 | // Instance methods
55 | // ------------------------------------------------------------
56 |
57 | /**
58 | * Retrieve the invalid realm id.
59 | *
60 | * @return The id.
61 | */
62 | public String getId() {
63 | return this.id;
64 | }
65 | }
66 |
--------------------------------------------------------------------------------
/src/main/java/org/codehaus/plexus/classworlds/strategy/AbstractStrategy.java:
--------------------------------------------------------------------------------
1 | package org.codehaus.plexus.classworlds.strategy;
2 |
3 | import java.net.URL;
4 | import java.util.Collection;
5 | import java.util.Collections;
6 | import java.util.Enumeration;
7 | import java.util.LinkedHashSet;
8 |
9 | import org.codehaus.plexus.classworlds.UrlUtils;
10 | import org.codehaus.plexus.classworlds.realm.ClassRealm;
11 |
12 | /*
13 | * Copyright 2001-2006 Codehaus Foundation.
14 | *
15 | * Licensed under the Apache License, Version 2.0 (the "License");
16 | * you may not use this file except in compliance with the License.
17 | * You may obtain a copy of the License at
18 | *
19 | * http://www.apache.org/licenses/LICENSE-2.0
20 | *
21 | * Unless required by applicable law or agreed to in writing, software
22 | * distributed under the License is distributed on an "AS IS" BASIS,
23 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
24 | * See the License for the specific language governing permissions and
25 | * limitations under the License.
26 | */
27 |
28 | /**
29 | * @author Jason van Zyl
30 | */
31 | public abstract class AbstractStrategy implements Strategy {
32 |
33 | protected ClassRealm realm;
34 |
35 | public AbstractStrategy(ClassRealm realm) {
36 | this.realm = realm;
37 | }
38 |
39 | protected String getNormalizedResource(String name) {
40 | return UrlUtils.normalizeUrlPath(name);
41 | }
42 |
43 | protected Enumeration15 | The Java API can be used to create new realms and connect 16 | realms together through importation of specific packages. 17 |
18 | 19 |
20 | The core of the Classworlds infrastructure is
21 | the
22 | ClassWorld
23 | class. An application must create a ClassWorld instance.
24 | It is advisable to store the instance as a singleton or some other
25 | handy location.
26 |
33 | Once a ClassWorld is created, realms within it
34 | can be created. These realms effectively only allow loading
35 | of the core JVM classes initially.
36 |
45 | In order to make each ClassRealm useful, constituents
46 | in form of URLs must be added to it where each can provide certain classes.
47 | The URL must return either a JAR or a directory on the default file system.
48 |
56 | ClassRealms can optionally be filtered to further restrict which classes/resources
57 | are exposed. The filter is provided as additional argument to world.newRealm( "filteredcontainer", myPredicate );
58 |
61 | Now, links between the various realms need to be created to allow 62 | classes loaded from one to be available to classes loaded in another. 63 |
64 | 65 |71 | The container implementation can then be loaded from its realm 72 | and used. 73 |
74 | 75 |
83 | Ideally, the container itself would be responsible for creating
84 | a ClassRealm for each component that's loaded, and
85 | importing the component contract interfaces into the component's
86 | ClassRealm and using loadClass(..)
87 | to gain entry into the sandboxed component realm.
88 |
15 | Plexus Classworlds is a framework for container developers 16 | who require complex manipulation of Java's ClassLoaders. Java's 17 | native ClassLoader mechanisms and classes can cause 18 | much headache and confusion for certain types of application 19 | developers. Projects which involve dynamic loading of components 20 | or otherwise represent a 'container' can benefit from the classloading 21 | control provided by Classworlds. 22 |
23 | 24 |25 | Plexus Classworlds provides a richer set of semantics for 26 | class loading than Java's normal mechanisms, while still being 27 | able to provide a ClassLoader interface to integrate 28 | seamlessly with the Java environment. 29 |
30 | 31 |
32 | The Classworlds model does away with the hierarchy
33 | normally associated with ClassLoaders. Instead,
34 | ClassWorld provides a
35 | pool of ClassRealms
36 | which can import arbitrary packages from other ClassRealms.
37 | Effectively, Classworlds turns the old-style
38 | hierarchy into a directed graph.
39 |
42 | In a application container environment, the container may 43 | have a realm capable of loading on the container/component 44 | contract interfaces and classes. Another realm is created 45 | for each component which imports the contract classes from 46 | the container realm. 47 |
48 | 49 |50 | This model allows for fine-grained control of which 51 | classloader loads any particular class. This form of 52 | partial isolation can reduce the myriad strange errors 53 | that are produced by loading classes from multiple 54 | loaders. 55 |
56 | 57 |
58 | In addition, Plexus Classworlds provides a
59 | launcher
60 | to assist in the creation of classloaders and ClassRealms
61 | from a configuration file and the launching of the application's main
62 | method from the correct class loaded through the correct classloader.
63 |
66 | And for seamless transition from older Classworlds up to 1.1, 67 | Plexus Classworlds provides 68 | a compatibility layer. 69 |
70 |17 | In order to reduce the number of classloading projects, 18 | Plexus Classworlds replaces forehead 19 | for application launching. 20 |
21 | 22 |
23 | The main problems to solve in application launching include
24 | locating all of application's JARs, configuring the initial
25 | classloaders, and invoking the main entry method.
26 |
29 | The launcher facilities
30 | of Classworlds simplify
31 | the process of locating application jars. A common idiom is
32 | to have a script which starts the JVM with only the
33 | plexus-classworlds.jar in the classpath and a system
34 | property to specify the location of a launcher configuration.
35 | Additionally, typically a property specifying the application installation
36 | location is passed on the command-line.
37 |
57 | The entry-point class and realm must be specified
58 | using the main is directive before
59 | specifying realm definitions.
60 |
71 | System properties can be set before and after the entry point, but before realms: 72 |
73 | 74 |
83 | At least one Classworlds realm must be defined
84 | within the configuration file. The syntax for starting a
85 | realm definition is [realm.name]. All lines
86 | following the realm header are considered directives for
87 | that realm. The realm definition continues either until
88 | another realm is defined or until the end of the file is
89 | reached.
90 |
105 | Within a realm definition, three directives are available:
106 | load, optionally and import.
107 |
110 | The load and optionally
111 | directives specify a class source to be used for loading
112 | classes in the realm: the only difference is that in case of absent source,
113 | load fails but optionally does not.
114 | Any loaded source that contain a star (*) in the file name is
115 | replaced by the list of files that match the filename prefix and suffix.
116 | System properties may be referred to using ${propname} notation.
117 | The load and optionally directives are equivalent to the
118 | addURL(..) method of ClassRealm.
119 |
129 | The import directive specifies that certain
130 | packages should be imported and loaded by way of another
131 | realm. The import directive is equivalent
132 | to the importFrom(..) method of
133 | ClassRealm.
134 |
150 | Classworlds can be used to invoke any existing
151 | application's main() method. Using the standard
152 | entry point does not allow for gaining access to the
153 | ClassWorld of the application, but not all
154 | applications will need it at run-time.
155 |
158 | For those applications that do require the ClassWorld
159 | instance, an alternative entry-point method signature can be
160 | provided. Simply add a ClassWorld parameter to
161 | the standard main parameter list.
162 |