SessionServerConfig.java revision 01f7f939eba03e95a87e8e4a6883d2591336a5ec
/**
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2005 Sun Microsystems Inc. All Rights Reserved
*
* The contents of this file are subject to the terms
* of the Common Development and Distribution License
* (the License). You may not use this file except in
* compliance with the License.
*
* You can obtain a copy of the License at
* See the License for the specific language governing
* permission and limitations under the License.
*
* When distributing Covered Code, include this CDDL
* Header Notice in each file and include the License file
* at opensso/legal/CDDLv1.0.txt.
* If applicable, add the following below the CDDL Header,
* with the fields enclosed by brackets [] replaced by
* your own identifying information:
* "Portions Copyrighted [year] [name of copyright owner]"
*
* $Id: SessionService.java,v 1.37 2010/02/03 03:52:54 bina Exp $
*
* Portions Copyrighted 2010-2016 ForgeRock AS.
*/
/**
* Responsible for collating WebtopNaming configuration state relating to the Session Service.
*
* @since 13.0.0
*/
public class SessionServerConfig {
/*
* Local server details are those of the server on which the code is executing.
*/
private String localServerID;
private final String localServerDeploymentPath;
private final URL localServerURL;
private final URL localServerSessionServiceURL;
private final Debug sessionDebug;
/**
* Constructor called by Guice to initialize the Singleton instance of SessionServerConfig.
*
* Initialization success is dependent on {@link WebtopNaming } being ready.
*/
this.sessionDebug = sessionDebug;
try {
// Rethrow exception rather than hobbling on with invalid configuration state
}
}
/**
* Gets the ID of the primary server.
*
* The server identified varies depending on whether or not this server is running as part of a site:
*
* - If a site is running, the primary server details refer to the site's primary server (usu. load balancer).
* - If a site hasn't been setup, then the primary server details will match the local server details.
*/
public String getPrimaryServerID() {
}
/**
* Gets the URL of the primary server.
*
* The server identified varies depending on whether or not this server is running as part of a site:
*
* - If a site is running, the primary server details refer to the site's primary server (usu. load balancer).
* - If a site hasn't been setup, then the primary server details will match the local server details.
*/
public URL getPrimaryServerURL() {
}
/**
* Gets ID for this OpenAM server from cache.
*/
public String getLocalServerID() {
return getLocalServerID(false);
}
/**
* Gets ID for this OpenAM server from cache or refreshed depends on the parameter
* @param forceReload - if true reloads the localServerID and does not use the cashed value.
*/
}
/**
* Gets the full URL for this OpenAM server.
*
*/
public URL getLocalServerURL() {
return localServerURL;
}
/**
* Gets the full URL for this OpenAM server's session service servlet.
*
*/
public URL getLocalServerSessionServiceURL() {
return localServerSessionServiceURL;
}
/**
* Indicates if this server is part of a Site (or multiple sites).
*/
public boolean isSiteEnabled() {
try {
} catch (Exception e) {
throw new IllegalStateException(e);
}
}
/**
* Returns the site ID for this Server.
* @return Returns a single Site ID for the server.
*/
if (isSiteEnabled()) {
}
return null;
}
/**
* @return Resolves the Site URL for the Site ID.
*/
public URL getSiteURL() {
if (isSiteEnabled()) {
try {
} catch (MalformedURLException | ServerEntryNotFoundException e) {
throw new IllegalStateException(e);
}
}
return null;
}
/**
* @return Returns the secondary Site IDs for the given Site ID.
*/
if (isSiteEnabled()) {
try {
return findSecondarySiteIDs(getLocalServerID());
} catch (ServerEntryNotFoundException e) {
throw new IllegalStateException(e);
}
} else {
return Collections.emptySet();
}
}
/**
* Checks if server instance identified by serverID is this OpenAM server.
*
* @param serverID server id, possibly null.
* @return true if serverID is the same as local instance, false otherwise.
*/
}
/**
* Checks if server instance identified by serverID is the primary server for this OpenAM server's site.
*
* How this check is performed varies depending on whether or not this server is running as part of a site:
*
* - If a site is running, the primary server details refer to the site's primary server (usu. load balancer).
* - If a site hasn't been setup, then the primary server details will match the local server details.
*/
}
/**
* This method is called by Session.getLocalServerSessionServiceURL, when routing a request to an individual session host. In
* this case, the SessionID.PRIMARY_ID extension is obtained from the SessionID instance (which corresponds to the
* AM-instance host of the session). WebtopNaming will then be called to turn this serverId (01,02, etc) into a
* URL which will point a PLL client GetSession request. Calling this method is part of insuring that the PLL GetSession
* request does not get routed to a site (load-balancer).
*
* This method checks whether the provided ID (let it be server or site ID)
* belongs to a local site. If the current server is not member of a site,
* then the ID will be compared to the current server's ID.
* @param siteID the server id (PRIMARY_ID) pulled from a presented cookie.
* @return <code>true</code> if the provided ID corresponds to a local server or site.
*/
localID = getLocalServerID();
}
}
/**
* Checks whether the provided ID belongs to a site or not.
*
* @param serverOrSiteId The ID that needs to be checked.
* @return <code>true</code> if the ID corresponds to a site.
*/
}
/**
* Checks if server instance identified by serverID is the same as local
* instance
*
* @param sid server id
* @return true if serverID is the same as local instance, false otherwise
*/
}
/**
* Creates a new URL by adding the provided path to the end of this OpenAM server's URL.
*
* e.g. Given the path "GetHttpSession?op=create", if this OpenAM server is deployed to
* https://openam.example.com:8080/openam then the resulting URL will be
*/
}
/**
* Creates a new URL by adding the provided path to the end of the provided server's URL.
*
* This assumes that the provided server URL does not include the deployment path of OpenAM
* since it can be assumed to be the same as this server's deployment path.
*
* e.g. Given the server URL "https://remote.example.com:8080" and the path "GetHttpSession?op=create",
* if this OpenAM server is deployed to "/openam" then the resulting URL will be
*/
return new URL(server.getProtocol(), server.getHost(), server.getPort(), localServerDeploymentPath + "/" + path);
}
/**
* Returns IDs for all servers in the current site. If this OpenAM server is not deployed as part
* of one or more sites, the returned set will only include this server's ID.
*/
}
}
return serverIDs;
}
/**
* Returns all server IDs.
*/
return WebtopNaming.getAllServerIDs();
}
/**
* Returns the server URL based on the server ID.
*/
}
/**
* Returns true if the URL is the URL of the local session service.
*
* @param url the url to check
* @return true if the url represents the local session service.
*/
}
/**
* Returns true if the url is the URL of the local notification service.
*
* @param url the url to check
* @return true if the url represents the local notification service.
*/
try {
} catch (URLNotFoundException ex) {
return false;
}
}
/**
* Returns the lbCookieValue corresponding to the server ID.
*/
public String getLBCookieValue() {
}
/**
* Checks if the first URL is a prefix of the second URL.
*
* Protocol and Host are compared case-insensitively but the path is compared case-sensitively.
*/
}
}
return value;
}
throws ServerEntryNotFoundException {
// TODO: Investigate this method further - under what circumstances does it actually return results?
if (secondarySites != null) {
while (st.hasMoreTokens()) {
}
} else {
}
}
}
private String refreshLocalServerID() {
try {
} catch (ServerEntryNotFoundException e) {
throw new IllegalStateException("Failed to load Session Server configuration", e);
}
return localServerID;
}
}