com.webfirmframework.wffweb.server.page.BrowserPageContext Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of wffweb Show documentation
Show all versions of wffweb Show documentation
A java framework to develop web applications
/*
* Copyright 2014-2016 Web Firm Framework
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.webfirmframework.wffweb.server.page;
import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;
import java.util.logging.Logger;
import com.webfirmframework.wffweb.WffRuntimeException;
/**
* @author WFF
* @since 2.0.0
*/
public enum BrowserPageContext {
INSTANCE;
public static final Logger LOGGER = Logger
.getLogger(BrowserPageContext.class.getName());
/**
* key httpSessionId, value : (key: instanceId, value: BrowserPage)
*/
private final Map> httpSessionIdBrowserPages;
/**
* key:- unique id for AbstractBrowserPage (AKA wff instance id in terms of
* wff) value:- AbstractBrowserPage
*/
private final Map instanceIdBrowserPage;
/**
* key:- unique id for AbstractBrowserPage (AKA wff instance id in terms of
* wff) value:- httpSessionId
*/
private final Map instanceIdHttpSessionId;
private BrowserPageContext() {
httpSessionIdBrowserPages = new ConcurrentHashMap>();
instanceIdBrowserPage = new ConcurrentHashMap();
instanceIdHttpSessionId = new ConcurrentHashMap();
}
/**
* @param httpSessionId
* @param browserPage
* @return the instance id (unique) of the browser page.
* @since 2.0.0
* @author WFF
*/
public String addBrowserPage(final String httpSessionId,
final BrowserPage browserPage) {
Map browserPages = httpSessionIdBrowserPages
.get(httpSessionId);
synchronized (this) {
if (browserPages == null) {
synchronized (this) {
browserPages = new ConcurrentHashMap();
}
httpSessionIdBrowserPages.put(httpSessionId, browserPages);
}
}
browserPages.put(browserPage.getInstanceId(), browserPage);
instanceIdBrowserPage.put(browserPage.getInstanceId(), browserPage);
instanceIdHttpSessionId.put(browserPage.getInstanceId(), httpSessionId);
return browserPage.getInstanceId();
}
/**
* @param httpSessionId
* @param instanceId
* @return
* @since 2.0.0
* @author WFF
*/
public BrowserPage getBrowserPage(final String httpSessionId,
final String instanceId) {
final Map browserPages = httpSessionIdBrowserPages
.get(httpSessionId);
if (browserPages != null) {
return browserPages.get(instanceId);
}
return null;
}
/**
* gets the browserPage object for the given instance id.
* BrowserPage#getBrowserPge(httpSessionId, instanceId) method is better
* than this method in terms of performance.
*
* @param instanceId
* @return browser page object if it exists otherwise null.
* @since 2.0.0
* @author WFF
*/
public BrowserPage getBrowserPage(final String instanceId) {
return instanceIdBrowserPage.get(instanceId);
}
/**
* This should be called when the http session is closed
*
* @param httpSessionId
* the session id of http session
* @since 2.0.0
* @author WFF
*/
public void destroyContext(final String httpSessionId) {
final Map httpSessionIdBrowserPage = httpSessionIdBrowserPages
.remove(httpSessionId);
if (httpSessionIdBrowserPage != null) {
for (final BrowserPage browserPage : httpSessionIdBrowserPage
.values()) {
instanceIdHttpSessionId.remove(browserPage.getInstanceId());
instanceIdBrowserPage.remove(browserPage.getInstanceId());
}
httpSessionIdBrowserPage.clear();
}
}
/**
* this method should be called when the websocket is opened
*
* @param wffInstanceId
* the wffInstanceId which can be retried from the request
* parameter in websocket connection
* @since 2.0.0
* @author WFF
*/
public void webSocketOpened(final String wffInstanceId) {
final String httpSessionId = instanceIdHttpSessionId.get(wffInstanceId);
if (httpSessionId != null) {
final Map browserPages = httpSessionIdBrowserPages
.get(httpSessionId);
if (browserPages != null) {
final BrowserPage browserPage = browserPages.get(wffInstanceId);
if (browserPage == null) {
throw new WffRuntimeException(
"The browserPage is not added in BrowserPageContext");
}
}
} else {
LOGGER.warning(
"The associatd HttpSession is alread closed for this instance id or browserPage is not added in BrowserPageContext");
}
}
/**
* this method should be called when the websocket is closed
*
* @param wffInstanceId
* the wffInstanceId which can be retried from the request
* parameter in websocket connection
* @since 2.0.0
* @author WFF
*/
public void webSocketClosed(final String wffInstanceId) {
// NOP for future development
}
/**
* should be called when the httpsession is closed. The closed http session
* id should be passed as an argument.
*
* @param httpSessionId
* @since 2.0.0
* @author WFF
*/
public void httpSessionClosed(final String httpSessionId) {
if (httpSessionId != null) {
final Map browserPages = httpSessionIdBrowserPages
.get(httpSessionId);
if (browserPages != null) {
for (final String instanceId : browserPages.keySet()) {
instanceIdHttpSessionId.remove(instanceId);
instanceIdBrowserPage.remove(instanceId);
}
httpSessionIdBrowserPages.remove(httpSessionId);
}
} else {
LOGGER.warning(
"The associatd HttpSession is alread closed for this instance id");
}
}
/**
* this method should be called when the websocket is closed
*
* @param wffInstanceId
* the wffInstanceId which can be retried from the request
* parameter in websocket connection.
* @since 2.0.0
* @author WFF
*/
public BrowserPage websocketMessaged(final String wffInstanceId,
final byte[] message) {
final BrowserPage browserPage = instanceIdBrowserPage
.get(wffInstanceId);
if (browserPage != null) {
browserPage.websocketMessaged(message);
}
return browserPage;
}
}