diff options
Diffstat (limited to 'sca-java-1.x/branches/pre-spec-changes/kernel/host-api/src/main')
20 files changed, 1126 insertions, 0 deletions
diff --git a/sca-java-1.x/branches/pre-spec-changes/kernel/host-api/src/main/java/org/apache/tuscany/host/AbstractRuntimeInfo.java b/sca-java-1.x/branches/pre-spec-changes/kernel/host-api/src/main/java/org/apache/tuscany/host/AbstractRuntimeInfo.java new file mode 100644 index 0000000000..513d02232a --- /dev/null +++ b/sca-java-1.x/branches/pre-spec-changes/kernel/host-api/src/main/java/org/apache/tuscany/host/AbstractRuntimeInfo.java @@ -0,0 +1,125 @@ +/* + * 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; + +import java.io.File; +import java.net.URL; +import java.net.URI; + +/** + * Abstract runtime info implementation. + * + * @version $Revision$ $Date$ + */ +public abstract class AbstractRuntimeInfo implements RuntimeInfo { + + /** + * This SCA Domain this runtime belongs to. + */ + private final URI domain; + + /** + * Application root directory. + */ + private final File applicationRootDirectory; + + /** + * Base URL. + */ + private final URL baseUrl; + + /** + * Online indicator. + */ + private final boolean online; + + /** + * Runtime Id. + */ + private String runtimeId; + + /** + * Initializes the runtime info instance. + * + * @param domain the SCA Domain that this runtime belongs to + * @param applicationRootDirectory Application root directory. + * @param baseUrl Base Url. + * @param online Onlne indicator. + * @param runtimeId Runtime Id. + */ + public AbstractRuntimeInfo(final URI domain, + final File applicationRootDirectory, + final URL baseUrl, + final boolean online, + final String runtimeId) { + this.domain = domain; + this.applicationRootDirectory = applicationRootDirectory; + this.baseUrl = baseUrl; + this.online = online; + this.runtimeId = runtimeId; + } + + /** + * Returns the SCA domain associated with this runtime. + * A null domain indicates that this is a standalone runtime with a self-contained assembly. + * + * @return the SCA domain associated with this runtime; may be null + */ + public URI getDomain() { + return domain; + } + + /** + * Returns the unique runtime is in the SCA domain. + * + * @return the SCA domain associated with this runtime; may be null + */ + public String getRuntimeId() { + return runtimeId; + } + + /** + * Return the root directory used to resolve application file paths. + * + * @return the directory used to resolve application file paths. + */ + public final File getApplicationRootDirectory() { + return applicationRootDirectory; + } + + /** + * Gets the base URL for the runtime. + * + * @return The base URL for the runtime. + */ + public final URL getBaseURL() { + return baseUrl; + } + + /** + * Returns whether the runtime considers itself "online" or connected to the internet. + * This can be used by services to enable access to remote resources. + * + * @return true if the runtime is online. + */ + public final boolean isOnline() { + return online; + } + +} diff --git a/sca-java-1.x/branches/pre-spec-changes/kernel/host-api/src/main/java/org/apache/tuscany/host/Launcher.java b/sca-java-1.x/branches/pre-spec-changes/kernel/host-api/src/main/java/org/apache/tuscany/host/Launcher.java new file mode 100644 index 0000000000..64f2e8b9a0 --- /dev/null +++ b/sca-java-1.x/branches/pre-spec-changes/kernel/host-api/src/main/java/org/apache/tuscany/host/Launcher.java @@ -0,0 +1,57 @@ +/* + * 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; + +import java.net.URL; + +import org.osoa.sca.CompositeContext; + +import org.apache.tuscany.api.TuscanyException; + +/** + * Interface that allows a host to launch a runtime. + * + * @version $Rev$ $Date$ + */ +public interface Launcher { + /** + * Boot the Tuscany runtime. + * + * @param systemScdl the SCDL defining the runtime's system configuration + * @param systemClassLoader the root classloader to use to deploy the system SCDL + * @param monitorFactory the monitor factory initialize the runtime with + * @throws TuscanyException if there was a problem booting the runtimr + */ + void bootRuntime(URL systemScdl, ClassLoader systemClassLoader, MonitorFactory monitorFactory) + throws TuscanyException; + + /** + * Shutdown the Tuscany runtime. + */ + void shutdownRuntime(); + + /** + * Boot a default application into the runtime. + * + * @param applicationScdl the application's SCDL + * @param applicationClassLoader the classloader to use to deploy the application + * @return the CompositeContext for the application + */ + CompositeContext bootApplication(URL applicationScdl, ClassLoader applicationClassLoader); +} diff --git a/sca-java-1.x/branches/pre-spec-changes/kernel/host-api/src/main/java/org/apache/tuscany/host/MonitorFactory.java b/sca-java-1.x/branches/pre-spec-changes/kernel/host-api/src/main/java/org/apache/tuscany/host/MonitorFactory.java new file mode 100644 index 0000000000..d338681641 --- /dev/null +++ b/sca-java-1.x/branches/pre-spec-changes/kernel/host-api/src/main/java/org/apache/tuscany/host/MonitorFactory.java @@ -0,0 +1,49 @@ +/* + * 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; + +import java.util.Map; + +/** + * A MonitorFactory creates implementations of components' monitor interfaces that interface with a its monitoring + * scheme. For example, a implementation may create versions that emit appropriate logging events or which send + * notifications to a management API. + * + * MonitorFactory implementations must provide a no-arg constructor and implement the {@link #initialize} method + * to perform configuration of instances created using that constructor. Additional constructors may be defined; + * typically their implementations delegate to {@link #initialize}. + * + * @version $Rev$ $Date$ + */ +public interface MonitorFactory { + /** + * Initializes MonitorFactory instances with implementation-specific configuration properties. + * + * @param configProperties a map of named configuration properties. May be null. + * @throws IllegalArgumentException if the instance can't be configured using the supplied properties + */ + void initialize(Map<String, Object> configProperties); + /** + * Return a monitor for a component's monitor interface. + * + * @param monitorInterface the component's monitoring interface + * @return an implementation of the monitoring interface; will not be null + */ + <T> T getMonitor(Class<T> monitorInterface); +} diff --git a/sca-java-1.x/branches/pre-spec-changes/kernel/host-api/src/main/java/org/apache/tuscany/host/RuntimeInfo.java b/sca-java-1.x/branches/pre-spec-changes/kernel/host-api/src/main/java/org/apache/tuscany/host/RuntimeInfo.java new file mode 100644 index 0000000000..c75e325256 --- /dev/null +++ b/sca-java-1.x/branches/pre-spec-changes/kernel/host-api/src/main/java/org/apache/tuscany/host/RuntimeInfo.java @@ -0,0 +1,72 @@ +/* + * 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; + +import java.io.File; +import java.net.URI; +import java.net.URL; + +/** + * Interface that provides information on the runtime environment. + * + * @version $Rev$ $Date$ + */ +public interface RuntimeInfo { + /** + * The default name that the runtime should assign to the component providing this service. + */ + String COMPONENT_NAME = "RuntimeInfo"; + + /** + * Returns the SCA domain associated with this runtime. + * A null domain indicates that this is a standalone runtime with a self-contained assembly. + * + * @return the SCA domain associated with this runtime; may be null + */ + URI getDomain(); + + /** + * Returns the unique runtime is in the SCA domain. + * + * @return the SCA domain associated with this runtime; may be null + */ + String getRuntimeId(); + + /** + * Return the root directory used to resolve application file paths. + * + * @return the directory used to resolve application file paths. + */ + File getApplicationRootDirectory(); + + /** + * Gets the base URL for the runtime. + * + * @return The base URL for the runtime. + */ + URL getBaseURL(); + + /** + * Returns whether the runtime considers itself "online" or connected to the internet. + * This can be used by services to enable access to remote resources. + * + * @return true if the runtime is online. + */ + boolean isOnline(); +} diff --git a/sca-java-1.x/branches/pre-spec-changes/kernel/host-api/src/main/java/org/apache/tuscany/host/deployment/AssemblyService.java b/sca-java-1.x/branches/pre-spec-changes/kernel/host-api/src/main/java/org/apache/tuscany/host/deployment/AssemblyService.java new file mode 100644 index 0000000000..50eb24fded --- /dev/null +++ b/sca-java-1.x/branches/pre-spec-changes/kernel/host-api/src/main/java/org/apache/tuscany/host/deployment/AssemblyService.java @@ -0,0 +1,52 @@ +/* + * 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.deployment; + +import java.io.IOException; +import java.io.InputStream; +import java.net.URL; + +/** + * Service interface for managing the logical assembly for a Tuscany runtime. + * + * @version $Rev$ $Date$ + */ +public interface AssemblyService { + /** + * Apply a set of changes to the SCA Domain's logical assembly. + * + * @param changeSet the location of a resource containing a set of changes + * @throws DeploymentException if there was a problem making the changes + * @throws IOException if there was a problem accessing the resource + */ + void applyChanges(URL changeSet) throws DeploymentException, IOException; + + /** + * Apply a set of changes to the SCA Domain's logical assembly. + * + * @param changeSet a stream for reading a resource containing a set of changes; the stream will not be closed + * but no guarantee is made on the position the stream is left in + * @param contentType the type of changeSet on the stream; must be a valid Content-Type value + * as specified by <a href="http://www.ietf.org/rfc/rfc2045.txt">RFC2045</a> + * and must not be null + * @throws DeploymentException if there was a problem making the changes + * @throws IOException if there was a problem reading the stream + */ + void applyChanges(InputStream changeSet, String contentType) throws DeploymentException, IOException; +} diff --git a/sca-java-1.x/branches/pre-spec-changes/kernel/host-api/src/main/java/org/apache/tuscany/host/deployment/ContentTypes.java b/sca-java-1.x/branches/pre-spec-changes/kernel/host-api/src/main/java/org/apache/tuscany/host/deployment/ContentTypes.java new file mode 100644 index 0000000000..a1f0b26b40 --- /dev/null +++ b/sca-java-1.x/branches/pre-spec-changes/kernel/host-api/src/main/java/org/apache/tuscany/host/deployment/ContentTypes.java @@ -0,0 +1,35 @@ +/* + * 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.deployment; + +/** + * Definitions of common Content-Type values. + * + * @version $Rev$ $Date$ + */ +public final class ContentTypes { + /** + * An Assembly changeSet represented as XML. + */ + public static final String CHANGESET_XML = "application/x-apache.tuscany.changeSet+xml"; + + private ContentTypes() { + } + +} diff --git a/sca-java-1.x/branches/pre-spec-changes/kernel/host-api/src/main/java/org/apache/tuscany/host/deployment/ContributionService.java b/sca-java-1.x/branches/pre-spec-changes/kernel/host-api/src/main/java/org/apache/tuscany/host/deployment/ContributionService.java new file mode 100644 index 0000000000..23cff119fc --- /dev/null +++ b/sca-java-1.x/branches/pre-spec-changes/kernel/host-api/src/main/java/org/apache/tuscany/host/deployment/ContributionService.java @@ -0,0 +1,58 @@ +/* + * 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.deployment; + +import java.io.IOException; +import java.io.InputStream; +import java.net.URI; +import java.net.URL; + +/** + * Service interface that manages artifacts contributed to a Tuscany runtime. + * + * @version $Rev$ $Date$ + */ +public interface ContributionService { + /** + * Contribute an artifact to the SCA Domain. + * The type of the contribution is determined by the Content-Type of the resource + * or, if that is undefined, by some implementation-specific means (such as + * mapping an extension in the URL's path). + * + * @param contribution the location of the resource containing the artifact + * @return a URI that uniquely identifies this contribution within the SCA Domain + * @throws DeploymentException if there was a problem with the contribution + * @throws IOException if there was a problem reading the resource + */ + URI contribute(URL contribution) throws DeploymentException, IOException; + + /** + * Contribute an artifact to the SCA Domain. + * + * @param source an identifier for the source of this contribution + * @param contribution a stream containing the resource being contributed; the stream will not be closed + * but the read position after the call is undefined + * @param contentType the type of contribution being made; must be a valid Content-Type value + * as specified by <a href="http://www.ietf.org/rfc/rfc2045.txt">RFC2045</a> + * and must not be null @return a URI that uniquely identifies this contribution within the SCA Domain + * @throws DeploymentException if there was a problem with the contribution + * @throws IOException if there was a problem reading the stream + */ + URI contribute(URI source, InputStream contribution, String contentType) throws DeploymentException, IOException; +} diff --git a/sca-java-1.x/branches/pre-spec-changes/kernel/host-api/src/main/java/org/apache/tuscany/host/deployment/DeploymentException.java b/sca-java-1.x/branches/pre-spec-changes/kernel/host-api/src/main/java/org/apache/tuscany/host/deployment/DeploymentException.java new file mode 100644 index 0000000000..95ebb50b5c --- /dev/null +++ b/sca-java-1.x/branches/pre-spec-changes/kernel/host-api/src/main/java/org/apache/tuscany/host/deployment/DeploymentException.java @@ -0,0 +1,51 @@ +/* + * 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.deployment; + +import org.apache.tuscany.api.TuscanyException; + +/** + * Base class for exceptions raised during deployment. + * + * @version $Rev$ $Date$ + */ +public abstract class DeploymentException extends TuscanyException { + protected DeploymentException() { + } + + protected DeploymentException(String message) { + super(message); + } + + protected DeploymentException(String message, String identifier) { + super(message, identifier); + } + + protected DeploymentException(String message, Throwable cause) { + super(message, cause); + } + + protected DeploymentException(String message, String identifier, Throwable cause) { + super(message, identifier, cause); + } + + protected DeploymentException(Throwable cause) { + super(cause); + } +} diff --git a/sca-java-1.x/branches/pre-spec-changes/kernel/host-api/src/main/java/org/apache/tuscany/host/deployment/UnsupportedContentTypeException.java b/sca-java-1.x/branches/pre-spec-changes/kernel/host-api/src/main/java/org/apache/tuscany/host/deployment/UnsupportedContentTypeException.java new file mode 100644 index 0000000000..d79fe3258a --- /dev/null +++ b/sca-java-1.x/branches/pre-spec-changes/kernel/host-api/src/main/java/org/apache/tuscany/host/deployment/UnsupportedContentTypeException.java @@ -0,0 +1,48 @@ +/* + * 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.deployment; + +/** + * Exception thrown to indicate that a Content-Type is not supported by this SCA Domain. + * The Content-Type value supplied will be returned as the message text for this exception. + * + * @version $Rev$ $Date$ + */ +public class UnsupportedContentTypeException extends DeploymentException { + + /** + * Constructor specifying the Content-Type value that is not supported. + * + * @param contentType the type that is not supported + */ + public UnsupportedContentTypeException(String contentType) { + super(contentType); + } + + /** + * Constructor specifying the Content-Type value that is not supported + * and an identifier to use with this exception (typically the resource being processed). + * + * @param contentType the type that is not supported + * @param identifier an identifier for this exception + */ + public UnsupportedContentTypeException(String contentType, String identifier) { + super(contentType, identifier); + } +} diff --git a/sca-java-1.x/branches/pre-spec-changes/kernel/host-api/src/main/java/org/apache/tuscany/host/management/ManagementService.java b/sca-java-1.x/branches/pre-spec-changes/kernel/host-api/src/main/java/org/apache/tuscany/host/management/ManagementService.java new file mode 100644 index 0000000000..1b62d3bbed --- /dev/null +++ b/sca-java-1.x/branches/pre-spec-changes/kernel/host-api/src/main/java/org/apache/tuscany/host/management/ManagementService.java @@ -0,0 +1,35 @@ +/* + * 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.management; + +/** + * + * @version $Revision$ $Date$ + */ +public interface ManagementService<T> { + + /** + * Registers the object for management. + * + * @param name Name under which the object is registered. + * @param managedObject Managed object to be registered. + */ + void registerComponent(String name, T managedObject); + +} diff --git a/sca-java-1.x/branches/pre-spec-changes/kernel/host-api/src/main/java/org/apache/tuscany/host/monitor/ExceptionFormatter.java b/sca-java-1.x/branches/pre-spec-changes/kernel/host-api/src/main/java/org/apache/tuscany/host/monitor/ExceptionFormatter.java new file mode 100644 index 0000000000..4c1e04ecb9 --- /dev/null +++ b/sca-java-1.x/branches/pre-spec-changes/kernel/host-api/src/main/java/org/apache/tuscany/host/monitor/ExceptionFormatter.java @@ -0,0 +1,34 @@ +/* + * 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.monitor; + +import java.io.PrintWriter; + +/** + * Formats exception data during a monitor event + * + * @version $Rev$ $Date$ + */ +public interface ExceptionFormatter { + + boolean canFormat(Class<?> type); + + PrintWriter write(PrintWriter writer, Throwable exception); + +} diff --git a/sca-java-1.x/branches/pre-spec-changes/kernel/host-api/src/main/java/org/apache/tuscany/host/monitor/FormatterRegistry.java b/sca-java-1.x/branches/pre-spec-changes/kernel/host-api/src/main/java/org/apache/tuscany/host/monitor/FormatterRegistry.java new file mode 100644 index 0000000000..277abb63a7 --- /dev/null +++ b/sca-java-1.x/branches/pre-spec-changes/kernel/host-api/src/main/java/org/apache/tuscany/host/monitor/FormatterRegistry.java @@ -0,0 +1,42 @@ +/* + * 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.monitor; + +/** + * A registry for exception formatters + * + * @version $Rev$ $Date$ + */ +public interface FormatterRegistry { + + /** + * Registers the given formatter + * + * @param formatter the formatter to register + */ + void register(ExceptionFormatter formatter); + + /** + * De-registers the given formatter + * + * @param formatter the formatter to de-register + */ + void unregister(ExceptionFormatter formatter); + +} diff --git a/sca-java-1.x/branches/pre-spec-changes/kernel/host-api/src/main/java/org/apache/tuscany/host/rmi/RMIHost.java b/sca-java-1.x/branches/pre-spec-changes/kernel/host-api/src/main/java/org/apache/tuscany/host/rmi/RMIHost.java new file mode 100644 index 0000000000..3dc68f430d --- /dev/null +++ b/sca-java-1.x/branches/pre-spec-changes/kernel/host-api/src/main/java/org/apache/tuscany/host/rmi/RMIHost.java @@ -0,0 +1,49 @@ +/* + * 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.rmi; + +import java.rmi.Remote; + +/* RMI Service hosting interface to be implemented by host environments that allows SCA Components + * to register RMI Services to handle inbound service requests over RMI to SCA Components + */ + +public interface RMIHost { + int RMI_DEFAULT_PORT = 1299; + + // registers an RMI service with the given name and port + void registerService(String serviceName, int port, Remote serviceObject) throws RMIHostException, + RMIHostRuntimeException; + + // registers an RMI service with the given name and default port (1099) + void registerService(String serviceName, Remote serviceObject) throws RMIHostException, + RMIHostRuntimeException; + + // unregister a service registered under the given service name and port number + void unregisterService(String serviceName, int port) throws RMIHostException, + RMIHostRuntimeException; + + // unregister a service registered under the given service name and defalut port number (1099) + void unregisterService(String serviceName) throws RMIHostException, + RMIHostRuntimeException; + + //find a remote service hosted on the given host, port and service name + Remote findService(String host, String port, String svcName) throws RMIHostException, + RMIHostRuntimeException; +} diff --git a/sca-java-1.x/branches/pre-spec-changes/kernel/host-api/src/main/java/org/apache/tuscany/host/rmi/RMIHostAdmin.java b/sca-java-1.x/branches/pre-spec-changes/kernel/host-api/src/main/java/org/apache/tuscany/host/rmi/RMIHostAdmin.java new file mode 100644 index 0000000000..dedfff1cdd --- /dev/null +++ b/sca-java-1.x/branches/pre-spec-changes/kernel/host-api/src/main/java/org/apache/tuscany/host/rmi/RMIHostAdmin.java @@ -0,0 +1,39 @@ +/* + * 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.rmi; + +import java.rmi.registry.Registry; +import java.util.List; + +/* RMI Service hosting Admin Interface to be implemented by host environments that allows SCA Components + * to register RMI Services to handle inbound service requests over RMI to SCA Components. This interface + * can be used by admin functions to obtain information on RMI registries started and running in the host + * environment + */ + +public interface RMIHostAdmin { + //gets all RMI registries running on the host. Each element of the list is an object of type + //java.rmi.registry + List getAllRegistries() throws RMIHostRuntimeException; + + //gets a registry that is running at a particular port + Registry getRegistry(int port) throws RMIHostRuntimeException; + + //more methods to be added +} diff --git a/sca-java-1.x/branches/pre-spec-changes/kernel/host-api/src/main/java/org/apache/tuscany/host/rmi/RMIHostException.java b/sca-java-1.x/branches/pre-spec-changes/kernel/host-api/src/main/java/org/apache/tuscany/host/rmi/RMIHostException.java new file mode 100644 index 0000000000..5d7733927d --- /dev/null +++ b/sca-java-1.x/branches/pre-spec-changes/kernel/host-api/src/main/java/org/apache/tuscany/host/rmi/RMIHostException.java @@ -0,0 +1,45 @@ +/* + * 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.rmi; + +import org.apache.tuscany.api.TuscanyException; + +/** + * This exception will relate to situations where the end applicaition's input is the cause of the exception + * + * @version $Rev$ $Date$ + */ +public class RMIHostException extends TuscanyException { + private static final long serialVersionUID = 8031031440259175970L; + + public RMIHostException() { + } + + public RMIHostException(String message) { + super(message); + } + + public RMIHostException(Throwable e) { + super(e); + } + + public RMIHostException(String message, Throwable cause) { + super(message, cause); + } +} diff --git a/sca-java-1.x/branches/pre-spec-changes/kernel/host-api/src/main/java/org/apache/tuscany/host/rmi/RMIHostRuntimeException.java b/sca-java-1.x/branches/pre-spec-changes/kernel/host-api/src/main/java/org/apache/tuscany/host/rmi/RMIHostRuntimeException.java new file mode 100644 index 0000000000..35b207b5d2 --- /dev/null +++ b/sca-java-1.x/branches/pre-spec-changes/kernel/host-api/src/main/java/org/apache/tuscany/host/rmi/RMIHostRuntimeException.java @@ -0,0 +1,45 @@ +/* + * 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.rmi; + +import org.apache.tuscany.api.TuscanyRuntimeException; + +/** + * This exception relates to cases where there is a problem with the + * Host runtime + * + */ +public class RMIHostRuntimeException extends TuscanyRuntimeException { + private static final long serialVersionUID = -1L; + + public RMIHostRuntimeException() { + } + + public RMIHostRuntimeException(String message) { + super(message); + } + + public RMIHostRuntimeException(Throwable e) { + super(e); + } + + public RMIHostRuntimeException(String message, Throwable cause) { + super(message, cause); + } +} diff --git a/sca-java-1.x/branches/pre-spec-changes/kernel/host-api/src/main/java/org/apache/tuscany/host/runtime/InitializationException.java b/sca-java-1.x/branches/pre-spec-changes/kernel/host-api/src/main/java/org/apache/tuscany/host/runtime/InitializationException.java new file mode 100644 index 0000000000..20b518609e --- /dev/null +++ b/sca-java-1.x/branches/pre-spec-changes/kernel/host-api/src/main/java/org/apache/tuscany/host/runtime/InitializationException.java @@ -0,0 +1,37 @@ +/* + * 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 org.apache.tuscany.api.TuscanyException; + +/** + * Denotes an error starting the runtime + * + * @version $Rev$ $Date$ + */ +public class InitializationException extends TuscanyException { + + public InitializationException(String message) { + super(message); + } + + public InitializationException(Throwable cause) { + super(cause); + } +} diff --git a/sca-java-1.x/branches/pre-spec-changes/kernel/host-api/src/main/java/org/apache/tuscany/host/runtime/ShutdownException.java b/sca-java-1.x/branches/pre-spec-changes/kernel/host-api/src/main/java/org/apache/tuscany/host/runtime/ShutdownException.java new file mode 100644 index 0000000000..769c928471 --- /dev/null +++ b/sca-java-1.x/branches/pre-spec-changes/kernel/host-api/src/main/java/org/apache/tuscany/host/runtime/ShutdownException.java @@ -0,0 +1,33 @@ +/* + * 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 org.apache.tuscany.api.TuscanyException; + +/** + * Denotes an error during runtime shutdown + * + * @version $Rev$ $Date$ + */ +public class ShutdownException extends TuscanyException { + + public ShutdownException(Throwable cause) { + super(cause); + } +} diff --git a/sca-java-1.x/branches/pre-spec-changes/kernel/host-api/src/main/java/org/apache/tuscany/host/runtime/TuscanyRuntime.java b/sca-java-1.x/branches/pre-spec-changes/kernel/host-api/src/main/java/org/apache/tuscany/host/runtime/TuscanyRuntime.java new file mode 100644 index 0000000000..fcbe4a829f --- /dev/null +++ b/sca-java-1.x/branches/pre-spec-changes/kernel/host-api/src/main/java/org/apache/tuscany/host/runtime/TuscanyRuntime.java @@ -0,0 +1,179 @@ +/* + * 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.CompositeContext; + +import org.apache.tuscany.host.MonitorFactory; +import org.apache.tuscany.host.RuntimeInfo; +import org.apache.tuscany.host.management.ManagementService; + +/** + * @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 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); + + /** + * Sets the ManagementService that this runtime should use. + * + * @param managementService the ManagementService that this runtime should use + */ + void setManagementService(ManagementService<?> managementService); + + /** + * Returns the ManagementService that this runtime is using. + * + * @return the ManagementService that this runtime is using + */ + ManagementService<?> getManagementService(); + + /** + * Initialize a runtime. + * + * @throws InitializationException if there is an error initializing the runtime + */ + void initialize() throws InitializationException; + + /** + * Destroy the runtime. Any further invocations should result in an error. + * + * @throws ShutdownException if there is an error destroying the runtime + */ + void destroy() throws ShutdownException; + + /** + * Returns the current SCA context + */ + @Deprecated + CompositeContext getContext(); + + /** + * Returns the name of the component associated with the application SCDL. + * + * @return the name of the component associated with the application SCDL + */ + @Deprecated + 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 + */ + @Deprecated + void setApplicationName(String applicationName); + + /** + * Returns the location of the default application's SCDL. + * + * @return the location of the default application's SCDL + */ + @Deprecated + URL getApplicationScdl(); + + /** + * Sets the location of the default application's SCDL + * + * @param applicationScdl the location of the default application's SCDL + */ + @Deprecated + void setApplicationScdl(URL applicationScdl); + + /** + * Get the application classloader + */ + @Deprecated + ClassLoader getApplicationClassLoader(); + + /** + * Set the application classloader + */ + @Deprecated + void setApplicationClassLoader(ClassLoader applicationClassLoader); + + /** + * Temporary API to allow and application to be deployed until we get the proper deployment services running. + * + * @param name the name of the component for the application + * @param scdlLocation the location of a SCDL composite document to use as the component's implementation + * @param classLoader the classloader to associated with the application component + * @return the context for the application's composite component + */ + @Deprecated + CompositeContext deployApplication(String name, URL scdlLocation, ClassLoader classLoader) + throws InitializationException; +} diff --git a/sca-java-1.x/branches/pre-spec-changes/kernel/host-api/src/main/java/org/apache/tuscany/host/servlet/ServletRequestInjector.java b/sca-java-1.x/branches/pre-spec-changes/kernel/host-api/src/main/java/org/apache/tuscany/host/servlet/ServletRequestInjector.java new file mode 100644 index 0000000000..e4b11aee90 --- /dev/null +++ b/sca-java-1.x/branches/pre-spec-changes/kernel/host-api/src/main/java/org/apache/tuscany/host/servlet/ServletRequestInjector.java @@ -0,0 +1,41 @@ +/* + * 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.servlet; + +import java.io.IOException; +import javax.servlet.ServletException; +import javax.servlet.ServletRequest; +import javax.servlet.ServletResponse; + +/** + * Interface to a system component that dispatches servlet requests to the Tuscany runtime + */ +public interface ServletRequestInjector { + + /** + * Dispatch servlet requests to the Tuscany runtime + * + * @param req the ServletRequest object that contains the request the client made of the servlet + * @param res the ServletResponse object that contains the response the servlet returns to the client + * @throws ServletException if the request cannot be handled + * @throws IOException if an input or output error occurs while handling the request + */ + void service(ServletRequest req, ServletResponse res) throws ServletException, IOException; + +} |