org.apache.oozie.service.Service Maven / Gradle / Ivy
/**
* Copyright (c) 2010 Yahoo! Inc. All rights reserved.
* Licensed 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. See accompanying LICENSE file.
*/
package org.apache.oozie.service;
/**
* A service is component managed by the {@link Services} singleton.
*/
public interface Service {
public static final String DEFAULT_LOCK_TIMEOUT = "oozie.service.default.lock.timeout";
/**
* Prefix for all services configuration properties.
*/
public static final String CONF_PREFIX = "oozie.service.";
/**
* Constant for XCommand
*/
public static final String USE_XCOMMAND = "oozie.useXCommand";
/**
* Initialize the service. Invoked by the {@link Service} singleton at start up time.
*
* @param services services singleton initializing the service.
* @throws ServiceException thrown if the service could not initialize.
*/
public void init(Services services) throws ServiceException;
/**
* Destroy the service. Invoked by the {@link Service} singleton at shutdown time.
*/
public void destroy();
/**
* Return the public interface of the service. Services are retrieved by its public interface. Specializations
* of services must return the public interface.
*
* @return the interface of the service.
*/
public Class getInterface();
/**
* Lock timeout value if service is only allowed to have one single running instance.
*/
public static long lockTimeout = Services.get().getConf().getLong(DEFAULT_LOCK_TIMEOUT, 5 * 1000);
}