本文介绍 JForum与已有的web应用的整合,以及JForum单点登陆原理与配置。
JForum可以单独作为一个BBS论坛运行,但是很多情况,我们需要在我们已有的WEB应用中集成JForum。
JForum的与已有WEB应用的集成有很多种方法。本文介绍JForum官方推荐的通过自定义SSO类实现来完成JForum与已有WEB应用的集成。
一.目标:
实现SSO (Single Sign On) :单点登陆。
一般来说,两个不同系统的整合的难点部分,便是需要解决单点登陆问题。
对于我们已有的WEB应用中的用户,若该用户已经登陆,并通过 联结迁移到JForum页面时,JForum要能够识别该用户已经登陆(不需要二次登陆)才不会让用户感到别扭(对用户来说,就好像使用的是同一个系统似的)。
但由于分属于2个不同的系统,所以它们之间不能共用同一套Session,这就需要使用一种特殊的机制来实现它们之间的互相通信。
好在,JForum为我们考虑到了这一点,它提供了灵活的SSO接口与配置机制,我们只需要简单地实现一个SSO类,同时在JForum的配置文件中加以配置即可。
二.JForum SSO机制的原理
- 当一个用户访问JForum时,JForum便会检查是否配置SSO,如果配置了SSO,JForum便会调用authenticateUser()方法。该方法简单地返回username或null。
- 若返回了一个不为空的username时,JForum将会检查是否匹配JForum数据库的userid。
- 若没有匹配的userid,JForum将动态加以创建
- JForum设置该user为登陆状态
- 若返回了一个null,则设置为“Anonymous”
- 若一个“Anonymous”用户试图访问权限以外的页面,JForum将根据SSO的设置导航到登陆页面,同时传递给一个登陆成功后应该迁移到的地址参数给login页面。
三.JForum SSO的实现
上面,我们大致了解了一下JForum的SSO机制的原理。根据SSO机制的原理,我们已经知道该怎么实现SSO。
1,需要实现一个SSO类,该类需要取得从另外一个系统登陆进来的用户信息。
一种最简单的方法是使用Cookie来实现。让已有的WEB应用在用户登陆时写入Cookie信息,然后JForum的SSO实现类中将该Cookie取出即可。
另外,还可以使用web-service,文件的写入等等方式来实现。反正一个最基本的原则是:用户登陆时写入用户信息,然后在JForum一方能取出相同信息即可。
2,配置JForum。
四.JForum SSO的配置
1.说明:已有的web项目域名:http://www.123.com
jforum域名:www.123.com/forum,
web项目和jfroum在同一台服务器和同一应用服务器下,如果分开可能会存在session或cookie访问的问题。
2.配置
(1)实现net.jforum.sso接口
public class CookieUserSSO implements SSO {
static final Logger logger = Logger.getLogger(CookieUserSSO.class.getName());
public String authenticateUser(RequestContext request) {
// login cookie set by my web LOGIN application
Cookie cookieNameUser = ControllerUtils.getCookie(SystemGlobals
.getValue(ConfigKeys.COOKIE_NAME_USER));
String username = null;
if (cookieNameUser != null) {
username = cookieNameUser.getValue();
}
logger.info("cookie username="+username);
System.out.println("cookie username="+username);
return username; // return username for jforum
// jforum will use this name to regist database or set in HttpSession
}
public boolean isSessionValid(UserSession userSession,
RequestContext request) {
Cookie cookieNameUser = ControllerUtils.getCookie(SystemGlobals
.getValue(ConfigKeys.COOKIE_NAME_USER)); // user cookie
String remoteUser = null;
if (cookieNameUser != null) {
remoteUser = cookieNameUser.getValue(); // jforum username
}
if (remoteUser == null
&& userSession.getUserId() != SystemGlobals
.getIntValue(ConfigKeys.ANONYMOUS_USER_ID)) {
// user has since logged out
return false;
} else if (remoteUser != null
&& userSession.getUserId() == SystemGlobals
.getIntValue(ConfigKeys.ANONYMOUS_USER_ID)) {
// anonymous user has logged in
return false;
} else if (remoteUser != null
&& !remoteUser.equals(userSession.getUsername())) {
// not the same user (cookie and session)
return false;
}
return true; // myapp user and forum user the same. valid user.
}
}
(2)修改SystemGlobals.properties中的配置:
修改SystemGlobals.properties文件中的一下属性的内容:
authentication.type = sso(代表启用sso)
sso.implementation = net.jforum.sso.CookieUserSSO(启用sso后每次url跳转都会到这个类)
sso.redirect = http://www.123.com/login.jsp //可根据实际的登录页面地址进行修改
cookie.name.user =jforumUserInfo
//web项目中保存的cookie名称,可根据实际情况修改
(3)修改web应用中的登录和注销部分的逻辑:
登录部分加入以下代码:
...
Cookie cookie =
new Cookie("jforumUserInfo", sname);
cookie.setMaxAge(-1);
cookie.setPath("/");//cookie只在同一应用服务器有效
response.addCookie(cookie);
...
注销部分加入以下代码:
......
Cookie cookie
= new Cookie("jforumUserInfo", "");
cookie.setMaxAge(0); // delete the cookie.
cookie.setPath("/");
response.addCookie(cookie);
......
(4)在web项目增加论坛的链接:
<a href="/forum">论坛</a>
文档下载:
补充说明:
经过以上的过程后,把论坛与 WEB 应用集成了,如果说在
WEB 中有某个会员,而在论坛里没有此会员,则在会员第一次进入论坛时,会在论坛里自动的注册一个新会员,它的名字与 WEB 应用中的会员名字相同。
经过以上的配制,还会存在些问题:
第一,会员进入论坛后无法修改自己信息,他的初始密码,总是错误的(初始密码默认为sso),因为这些会员都是自动注册的。要怎么样在自动注册时给个初始密码呢?
------- 修改 SystemGlobals.properties
,
sso.default.password = e10adc3949ba59abbe56e057f20f883e ,
注意, jforum 里会员的密码是有经过加密的,其中“e10adc3949ba59abbe56e057f20f883e ”表示“ 123456 ”
第二,经过以前修改后,“游客”是无法访问论坛的,如果说想让“游客”也可以访问论坛,则修改
CookieUserSSO 类:
把
if (cookieNameUser != null) { username = cookieNameUser.getValue(); }
修改成
if (cookieNameUser != null ){ username = cookieNameUser.getValue(); } else { cookieNameUser = new Cookie( "jforumUserInfo" , "Anonymous" ); cookieNameUser.setPath( "/" ); cookieNameUser.setMaxAge(-1); // 设置 cookie 的生命周期为:会话级,即浏览器关闭,该 cookie 就消失了 username = "Anonymous" ; }
把
if (cookieNameUser != null) { remoteUser = cookieNameUser.getValue(); // jforum username }修改成
if (cookieNameUser != null ){ remoteUser = cookieNameUser.getValue(); // jforum username } else { cookieNameUser = new Cookie( "jforumUserInfo" , "Anonymous" ); cookieNameUser.setPath( "/" ); cookieNameUser.setMaxAge(-1); // 设置 cookie 的生命周期为:会话级,即浏览器关闭,该 cookie 就消失了 remoteUser = "Anonymous" ; }
说明:“ Anonymous ”是一个默认的“游客”会员,存放于数据库中了