ecf1257183378eed78053afa34a6f3f8b3cda6abPhill Cunnington/*
ecf1257183378eed78053afa34a6f3f8b3cda6abPhill Cunnington * The contents of this file are subject to the terms of the Common Development and
ecf1257183378eed78053afa34a6f3f8b3cda6abPhill Cunnington * Distribution License (the License). You may not use this file except in compliance with the
ecf1257183378eed78053afa34a6f3f8b3cda6abPhill Cunnington * License.
ecf1257183378eed78053afa34a6f3f8b3cda6abPhill Cunnington *
ecf1257183378eed78053afa34a6f3f8b3cda6abPhill Cunnington * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
ecf1257183378eed78053afa34a6f3f8b3cda6abPhill Cunnington * specific language governing permission and limitations under the License.
ecf1257183378eed78053afa34a6f3f8b3cda6abPhill Cunnington *
ecf1257183378eed78053afa34a6f3f8b3cda6abPhill Cunnington * When distributing Covered Software, include this CDDL Header Notice in each file and include
ecf1257183378eed78053afa34a6f3f8b3cda6abPhill Cunnington * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
ecf1257183378eed78053afa34a6f3f8b3cda6abPhill Cunnington * Header, with the fields enclosed by brackets [] replaced by your own identifying
ecf1257183378eed78053afa34a6f3f8b3cda6abPhill Cunnington * information: "Portions copyright [year] [name of copyright owner]".
ecf1257183378eed78053afa34a6f3f8b3cda6abPhill Cunnington *
ecf1257183378eed78053afa34a6f3f8b3cda6abPhill Cunnington * Copyright 2016 ForgeRock AS.
ecf1257183378eed78053afa34a6f3f8b3cda6abPhill Cunnington */
ecf1257183378eed78053afa34a6f3f8b3cda6abPhill Cunnington
ecf1257183378eed78053afa34a6f3f8b3cda6abPhill Cunningtonpackage com.sun.identity.sm;
ecf1257183378eed78053afa34a6f3f8b3cda6abPhill Cunnington
ecf1257183378eed78053afa34a6f3f8b3cda6abPhill Cunningtonimport com.iplanet.sso.SSOToken;
ecf1257183378eed78053afa34a6f3f8b3cda6abPhill Cunnington
ecf1257183378eed78053afa34a6f3f8b3cda6abPhill Cunnington/**
ecf1257183378eed78053afa34a6f3f8b3cda6abPhill Cunnington * Factory interface for creating {@link OrganizationConfigManager} instances.
ecf1257183378eed78053afa34a6f3f8b3cda6abPhill Cunnington *
ecf1257183378eed78053afa34a6f3f8b3cda6abPhill Cunnington * @since 14.0.0
ecf1257183378eed78053afa34a6f3f8b3cda6abPhill Cunnington */
ecf1257183378eed78053afa34a6f3f8b3cda6abPhill Cunningtonpublic interface OrganizationConfigManagerFactory {
ecf1257183378eed78053afa34a6f3f8b3cda6abPhill Cunnington
ecf1257183378eed78053afa34a6f3f8b3cda6abPhill Cunnington /**
ecf1257183378eed78053afa34a6f3f8b3cda6abPhill Cunnington * Creates a {@link OrganizationConfigManager} for the provided {@literal realm}.
ecf1257183378eed78053afa34a6f3f8b3cda6abPhill Cunnington *
ecf1257183378eed78053afa34a6f3f8b3cda6abPhill Cunnington * @param token The {@code SSOToken} instance.
ecf1257183378eed78053afa34a6f3f8b3cda6abPhill Cunnington * @param realm The realm. If {@code null} the root realm will be used.
ecf1257183378eed78053afa34a6f3f8b3cda6abPhill Cunnington * @return A {@code OrganizationConfigManager} instance.
ecf1257183378eed78053afa34a6f3f8b3cda6abPhill Cunnington * @throws SMSException If an error occurrs while getting the {@code OrganizationConfigManager}.
ecf1257183378eed78053afa34a6f3f8b3cda6abPhill Cunnington */
ecf1257183378eed78053afa34a6f3f8b3cda6abPhill Cunnington OrganizationConfigManager create(SSOToken token, String realm) throws SMSException;
ecf1257183378eed78053afa34a6f3f8b3cda6abPhill Cunnington}