org.sca4j.spi.component.AtomicComponent Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of sca4j-spi Show documentation
Show all versions of sca4j-spi Show documentation
SCA4J SPIs for fabric extensions.
/**
* SCA4J
* Copyright (c) 2009 - 2099 Service Symphony Ltd
*
* Licensed to you under the Apache License, Version 2.0 (the "License"); you may
* not use this file except in compliance with the License. A copy of the license
* is included in this distrubtion or you may obtain a copy at
*
* http://www.opensource.org/licenses/apache2.0.php
*
* 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.
*
* This project contains code licensed from the Apache Software Foundation under
* the Apache License, Version 2.0 and original code from project contributors.
*
*
* Original Codehaus Header
*
* Copyright (c) 2007 - 2008 fabric3 project contributors
*
* Licensed to you under the Apache License, Version 2.0 (the "License"); you may
* not use this file except in compliance with the License. A copy of the license
* is included in this distrubtion or you may obtain a copy at
*
* http://www.opensource.org/licenses/apache2.0.php
*
* 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.
*
* This project contains code licensed from the Apache Software Foundation under
* the Apache License, Version 2.0 and original code from project contributors.
*
* Original Apache Header
*
* Copyright (c) 2005 - 2006 The Apache Software Foundation
*
* Apache Tuscany is an effort undergoing incubation at The Apache Software
* Foundation (ASF), sponsored by the Apache Web Services PMC. Incubation is
* required of all newly accepted projects until a further review indicates that
* the infrastructure, communications, and decision making process have stabilized
* in a manner consistent with other successful ASF projects. While incubation
* status is not necessarily a reflection of the completeness or stability of the
* code, it does indicate that the project has yet to be fully endorsed by the ASF.
*
* This product includes software developed by
* The Apache Software Foundation (http://www.apache.org/).
*/
/*
* 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.sca4j.spi.component;
import java.net.URI;
import org.sca4j.spi.ObjectCreationException;
import org.sca4j.spi.ObjectFactory;
import org.sca4j.spi.invocation.WorkContext;
/**
* The runtime instantiation of an SCA atomic, or leaf-type, component
*
* @version $Rev: 3020 $ $Date: 2008-03-04 03:16:33 +0000 (Tue, 04 Mar 2008) $
* @param the type of the Java instance associated with this component
*/
public interface AtomicComponent extends Component {
/**
* Returns the group containing this component.
*
* @return the group containing this component
*/
URI getGroupId();
/**
* Returns true if component instances should be eagerly initialized.
*
* @return true if component instances should be eagerly initialized
*/
boolean isEagerInit();
/**
* Returns the initialization level for this component.
*
* @return the initialization level for this component
*/
int getInitLevel();
/**
* Returns the idle time allowed between operations in milliseconds if the implementation is conversational.
*
* @return the idle time allowed between operations in milliseconds if the implementation is conversational
*/
long getMaxIdleTime();
/**
* Returns the maximum age a conversation may remain active in milliseconds if the implementation is
* conversational.
*
* @return the maximum age a conversation may remain active in milliseconds if the implementation is conversational
*/
long getMaxAge();
/**
* Create a new implementation instance, fully injected with all property and reference values. The instance's
* lifecycle callbacks must not have been called.
*
* @param workContext the work context in which to create the instance
* @return a wrapper for a new implementation instance
* @throws ObjectCreationException if there was a problem instantiating the implementation
*/
InstanceWrapper createInstanceWrapper(WorkContext workContext) throws ObjectCreationException;
/**
* Create an ObjectFactory that returns an instance of this AtomicComponent.
*
* @return an ObjectFactory that returns an instance of this AtomicComponent
*/
@Deprecated
ObjectFactory createObjectFactory();
/**
* Create an ObjectFactory that returns instances that can be used as references to the specified service.
*
* @param type the type of reference to return; instances must be assignable to this class
* @param serviceName the name of the service being referenced
* @param the type of the reference
* @return an ObjectFactory for instances of a reference
* @throws ObjectCreationException if there was problem creating the factory
*/
ObjectFactory createObjectFactory(Class type, String serviceName) throws ObjectCreationException;
}