All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.sun.appserv.management.client.prefs.LoginInfoStore Maven / Gradle / Ivy

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 1997-2010 Oracle and/or its affiliates. All rights reserved.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License.  You can
 * obtain a copy of the License at
 * https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
 * or packager/legal/LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 *
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at packager/legal/LICENSE.txt.
 *
 * GPL Classpath Exception:
 * Oracle designates this particular file as subject to the "Classpath"
 * exception as provided by Oracle in the GPL Version 2 section of the License
 * file that accompanied this code.
 *
 * Modifications:
 * If applicable, add the following below the License Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyright [year] [name of copyright owner]"
 *
 * Contributor(s):
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */

package com.sun.appserv.management.client.prefs;
import java.util.Collection;

/**
 * An interface that represents the database of LoginInfo objects. Provides methods
 * to access and mutate the store. The general contract of store update comprises of the following:
 * 
    *
  • The store can contain at the most one LoginInfo for a host and port combination
  • *
  • There is no guarantee that concurrent modification of this store by two * different programs will always be consistent.
  • *
* @since Appserver 9.0 */ public interface LoginInfoStore { /** * Returns a {@link LoginInfo} corresponding to the given host and port, from this store. * The host may not be null. For a given host and port, there can be at most * one LoginInfo in this store. * @param host a non null String representing host name * @param port an integer specifying the port number * @return the corresponding LoginInfo, null if there is none * @throws StoreException if there is something wrong with reading the store * @throws IllegalArgumentException if the parameter host is null */ public LoginInfo read(final String host, final int port) throws StoreException; /** * Removes the {@link LoginInfo} corresponding to the given host and port, from this store. * The host may not be null. If no such LoginInfo exists, StoreException results. * The caller thus must ensure if such a LoginInfo exists before calling this method. * Upon successful return, size of this store decreases by one. * @param host a non null String representing host name * @param port an integer specifying the port number * @throws StoreException if there is something wrong with reading the store or if there is * no such LoginInfo * @throws IllegalArgumentException if the parameter host is null */ public void remove(final String host, final int port) throws StoreException; /** * Stores the given LoginInfo in this store. Given LoginInfo may not be null. * Upon successful return, the size of this store increases by one. An exception is thrown * if there is already a LoginInfo with given host and port. * @param login a LoginInfo that needs to be stored * @throws StoreException if there's any problem or if there is already a LoginInfo * with given host and port * @throws IllegalArgumentException if the given LoginInfo is null */ public void store(final LoginInfo login) throws StoreException; /** * Stores the given LoginInfo in this store. Given LoginInfo may not be null. * Upon successful return, the size of this store increases by one. An exception is thrown * if there is already a LoginInfo with given host and port and overwrite is false. * If overwrite is true, the given LoginInfo is stored regardless of whether it already * exists in this store. Depending upon the value of overwrite, the store is either unchanged * or not. * @param login a LoginInfo that needs to be stored * @throws StoreException if there's any problem in storing or if overwrite is false and * the LoginInfo with given host and port already exists * @throws IllegalArgumentException if the given LoginInfo is null */ public void store(final LoginInfo login, final boolean overwrite) throws StoreException; /** * Checks whether a LoginInfo for given host and port exists in this store. * @param host a non null String representing host name * @param port an integer specifying the port number * @throws StoreException if there's any problem reading the store */ public boolean exists(final String host, final int port) throws StoreException; /** * A convenience method that returns the Collection of LoginInfo instances stored in this store. * An empty Collection is returned when there are no LoginInfo items stored. * @return the Collection of LoginInfo instances * @throws StoreException if there's any problem reading the store */ public Collection list() throws StoreException; /** * A convenience method that returns the number of LoginInfo instances stored in this store. * Zero is returned when no login information is stored. * @return an integer representing number of stored login information elements, 0 if none * @throws StoreException if there's any problem reading the store */ public int size() throws StoreException; /** Returns the name of the store. * This is any name that the store implementation wants to use for identification, for instance. */ public String getName(); }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy