8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * Copyright (c) 2005 Sun Microsystems Inc. All Rights Reserved
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * The contents of this file are subject to the terms
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * of the Common Development and Distribution License
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * (the License). You may not use this file except in
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * compliance with the License.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * You can obtain a copy of the License at
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * https://opensso.dev.java.net/public/CDDLv1.0.html or
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * See the License for the specific language governing
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * permission and limitations under the License.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * When distributing Covered Code, include this CDDL
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * Header Notice in each file and include the License file
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * If applicable, add the following below the CDDL Header,
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * with the fields enclosed by brackets [] replaced by
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * your own identifying information:
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * "Portions Copyrighted [year] [name of copyright owner]"
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * $Id: ClientTypesManager.java,v 1.3 2008/06/25 05:41:32 qcheng Exp $
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * Interface that needs to be implemented by external applications inorder to do
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * some special processing for client management. The implementation module is
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * pluggable and is configurable via <code>AMConfig.properties</code>. The
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * property to set is <code>com.iplanet.ClientTypesManagerImpl</code>.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @supported.all.api
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * Initializes the <code>ClientTypesManager</code>.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * Gets all client instance as Map.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @return Map of clients. Key is the client type, value is the Client
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * Gets client object for specified client type.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @param clientType
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * requested client type.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @return The requested Client object
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster public Client getClientInstance(String clientType);
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * Gets client object for specified client type with specified token
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @param clientType
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * requested client type
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @param token
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @return The requested Client object
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster public Client getClientInstance(String clientType, SSOToken token);
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * Returns properties of the requested client type
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @param clientType
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * requested client type
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @return All properties of the request client type as Map
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster public Map getClientTypeData(String clientType);
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * Gets default client type name
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @return The default client type name
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * Get names of all client types
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @return Set of client types as String
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * Reload all Client data.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @throws ClientException
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * if having problem update client data
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster public void updateClientData() throws ClientException;
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * Save changed to persistent store.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @param token
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * single sign on Token of the caller.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @throws SSOException
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * if the token is not valid.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @throws SMSException
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * if having problem saving changes.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster public void store(SSOToken token) throws SMSException, SSOException;
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * Updates client data. Need to call <code>store()</code> after this
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @param clientType
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * client type
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @param data
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * client data. Key is the property name and value is the
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * property value as String.