mailbox/api/src/main/java/org/apache/james/mailbox/MailboxSessionIdGenerator.java

/****************************************************************
 * 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.james.mailbox;


/**
 * Generator for id's which should used for new {@link MailboxSession} instances
 */
public interface MailboxSessionIdGenerator {

    /**
     * Return the next id to use for a {@link MailboxSession}. The id must be unique
     * while the server is running and can be any long except {@link MailboxSession#SYSTEM_SESSION_ID}.
     * 
     * The returned ids can be in any specific order.
     */
    long nextId();
}