FileDocCategorySizeDatePackage
LoginInfoStore.javaAPI DocGlassfish v2 API6723Fri May 04 22:30:32 BST 2007com.sun.appserv.management.client.prefs

LoginInfoStore

public interface LoginInfoStore
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

Fields Summary
Constructors Summary
Methods Summary
public booleanexists(java.lang.String host, int port)
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 java.lang.StringgetName()
Returns the name of the store. This is any name that the store implementation wants to use for identification, for instance.

public java.util.Collectionlist()
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 LoginInforead(java.lang.String host, int port)
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 voidremove(java.lang.String host, int port)
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 intsize()
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 voidstore(LoginInfo login)
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 voidstore(LoginInfo login, boolean overwrite)
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