org.quartz.spi.InstanceIdGenerator Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of quartz Show documentation

Enterprise Job Scheduler

There is a newer version: 2.5.0-rc1

/* 
 * Copyright 2001-2009 Terracotta, Inc. 
 * 
 * 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.
 * 
 */
package org.quartz.spi;

import org.quartz.SchedulerException;

/**
 * 
 * An InstanceIdGenerator is responsible for generating the clusterwide unique 
 * instance id for a Scheduler node.
 * 
 * 
 * 
 * This interface may be of use to those wishing to have specific control over 
 * the mechanism by which the Scheduler instances in their 
 * application are named.
 * 
 * 
 * @see org.quartz.simpl.SimpleInstanceIdGenerator
 */
public interface InstanceIdGenerator {
    /**
     * Generate the instance id for a Scheduler
     * 
     * @return The clusterwide unique instance id.
     */
    String generateInstanceId() throws SchedulerException;
}