summaryrefslogtreecommitdiffstats
path: root/sca-java-1.x/tags/1.0-incubator-M2/kernel/host-api/src/main/java/org/apache/tuscany/host/runtime/TuscanyRuntime.java
blob: 72bdc38774ffd35f36a5518de5bf87d7f91a9805 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 * 
 *   http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.    
 */
package org.apache.tuscany.host.runtime;

import java.net.URL;

import org.osoa.sca.SCA;

import org.apache.tuscany.host.RuntimeInfo;
import org.apache.tuscany.host.MonitorFactory;

/**
 * @version $Rev$ $Date$
 */
public interface TuscanyRuntime {
    /**
     * Returns the location of the SCDL used to boot this runtime.
     *
     * @return the location of the SCDL used to boot this runtime
     */
    URL getSystemScdl();

    /**
     * Sets the location of the SCDL used to boot this runtime.
     *
     * @param systemScdl the location of the SCDL used to boot this runtime
     */
    void setSystemScdl(URL systemScdl);

    /**
     * Returns the name of the component associated with the application SCDL.
     * @return the name of the component associated with the application SCDL
     */
    String getApplicationName();

    /**
     * Sets the name of the component associated with the application SCDL.
     * @param applicationName the name of the component associated with the application SCDL
     */
    void setApplicationName(String applicationName);

    /**
     * Returns the location of the default application's SCDL.
     *
     * @return the location of the default application's SCDL
     */
    URL getApplicationScdl();

    /**
     * Sets the location of the default application's SCDL
     *
     * @param applicationScdl the location of the default application's SCDL
     */
    void setApplicationScdl(URL applicationScdl);

    /**
     * Returns the host ClassLoader that is parent to all Tuscany classloaders.
     *
     * @return the host's ClassLoader
     */
    ClassLoader getHostClassLoader();

    /**
     * Sets the host ClassLoader; this will be a parent for all Tuscany classloaders.
     *
     * @param classLoader the host's ClassLoader
     */
    void setHostClassLoader(ClassLoader classLoader);

    /**
     * Returns the info this runtime will make available to service components.
     *
     * @return the info this runtime will make available to service components
     */
    RuntimeInfo getRuntimeInfo();

    /**
     * Sets the info this runtime should make available to service components.
     * The instance supplied here should be registered in the system composite with the name
     * {@link RuntimeInfo#COMPONENT_NAME "RuntimeInfo"}.
     *
     * @param runtimeInfo the information this runtime should make available to service components
     */
    void setRuntimeInfo(RuntimeInfo runtimeInfo);

    /** Returns the MonitorFactory that this runtime is using.
     *
     * @return the MonitorFactory that this runtime is using
     */
    MonitorFactory getMonitorFactory();

    /**
     * Sets the MonitorFactory that this runtime should use.
     * @param monitorFactory the MonitorFactory that this runtime should use
     */
    void setMonitorFactory(MonitorFactory monitorFactory);

    /**
     * Create the default MonitorFactory for this runtime.
     *
     * @return the default MonitorFactory for this runtime
     */
    MonitorFactory createDefaultMonitorFactory();

    /**
     * Initialize a runtime.
     *
     */
    void initialize();

    /**
     * Destroy the runtime. Any further invocations should result in an error.
     */
    void destroy();

    /**
     * Returns the current SCA context
     */
    SCA getContext();

    /**
     * Get the application classloader
     */
    ClassLoader getApplicationClassLoader();

    /**
     * Set the application classloader
     */
    void setApplicationClassLoader(ClassLoader applicationClassLoader);
}