AbstractAction.java 9.22 KB
Newer Older
Kim Gyeongeun committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325
package jp.agentec.sinaburocast.action;

import java.io.IOException;
import java.util.Map;

import javax.servlet.ServletContext;
import javax.servlet.http.Cookie;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.HttpSession;

import jp.agentec.sinaburocast.common.SessionBindingListener;
import jp.agentec.sinaburocast.common.SinaburoConstant;
import jp.agentec.sinaburocast.common.SinaburoConstant.AttrKey;
import jp.agentec.sinaburocast.common.util.ServletUtil;
import jp.agentec.sinaburocast.entity.AdminUser;
import jp.agentec.sinaburocast.entity.Member;
import jp.agentec.sinaburocast.vo.AuthenticatedTokenVO;

import org.apache.log4j.Logger;
import org.apache.struts.Globals;
import org.apache.struts.action.ActionMessage;
import org.apache.struts.action.ActionMessages;
import org.seasar.framework.container.S2Container;
import org.seasar.struts.annotation.Execute;

/**
 * AbstractActionクラス
 *
 *
 */
public abstract class AbstractAction {
	private final Logger logger = Logger.getLogger(getClass());

	public ServletContext application;
	public S2Container container;
	public HttpSession session;
	public HttpServletRequest request;
	public HttpServletResponse response;

	@javax.annotation.Resource
    protected Map<String, Object> sessionScope;

    /**
     * サブクラスでindex()を定義していないのにアクセスされた場合に404エラーへ飛ばす.
     *
     * 定義しておかないと例外が発生するための対処
     * @return
     * @throws Exception
     */
	@Execute(validator=false)
    public String index() throws Exception {
		response.sendError(HttpServletResponse.SC_NOT_FOUND);
    	return null;
    }

	/**
	 * エラーメッセージがあるかどうかを返します.
	 *
	 * @return エラーメッセージがあるかどうか
	 */
    protected boolean hasErrors() {
    	return	ServletUtil.hasErrors(request);
    }

	/**
	 * メッセージ設定.
	 *
	 * application_ja.propertiesにpropertyとlabelが設定されていない場合に使用。
	 * @param messageOrProperty エラーメッセージ or propertyキー(引数がないもの)
	 */
	protected void addMessage(String messageOrProperty){
		ServletUtil.addMessage(request, messageOrProperty);
	}

	/**
	 * エラーメッセージ.
	 *
	 * application_ja.propertiesにpropertyとlabelが設定されていない場合に使用。
	 * @param messageOrProperty エラーメッセージ or propertyキー(引数がないもの)
	 */
	protected void addError(String messageOrProperty){
		ServletUtil.addError(request, messageOrProperty);
	}

	/**
	 * メッセージ設定.
	 *
	 * application_ja.propertiesにpropertyとlabelが設定されている場合に使用。
	 * @param property プロパティ名. errors.YYY等
	 * @param args 置換パラメータ. プロパティ名でないことに注意。
	 */
	protected void addMessage(String property, String... args){
		ServletUtil.addMessage(request, property, args);
	}

	/**
	 * エラーメッセージ.
	 *
	 * application_ja.propertiesにpropertyとlabelが設定されている場合に使用。
	 * @param property プロパティ名. errors.YYY等
	 * @param args 置換パラメータ. プロパティ名でないことに注意。
	 */
	protected void addError(String property, String... args){
		ServletUtil.addError(request, property, args);
	}

	/**
	 * セッションへのメッセージ設定.
	 *
	 * リダイレクトを超えて伝達したい場合に使用する。
	 * application_ja.propertiesにpropertyとlabelが設定されている場合に使用。
	 * @param property プロパティ名. errors.YYY等
	 * @param args 置換パラメータ. プロパティ名でないことに注意。
	 */
	protected void addMessage2session(String property, String... args){
		ServletUtil.addMessage(session, property, args);
	}

	/**
	 * セッションへのエラーメッセージ設定.
	 *
	 * リダイレクトを超えて伝達したい場合に使用する。
	 * application_ja.propertiesにpropertyとlabelが設定されている場合に使用。
	 * @param property プロパティ名. errors.YYY等
	 * @param args 置換パラメータ. プロパティ名でないことに注意。
	 */
	protected void addError2session(String property, String... args){
		ServletUtil.addError(session, property, args);
	}
	
	/**
	 * propertyを利用して画面から直接取得できる。 
	 * @param property 画面側で表示する場所で必要とする。
	 * @param key      keyでapp_jp.propertiesを検索する。isResourceがfalseの場合メーッセージを入れる。
	 * @param args     argsで埋め込む
	 */
	public void addErrorMessage(String property,String key,String... args){
		ActionMessages messages = (ActionMessages)request.getAttribute(Globals.ERROR_KEY);
		if (messages == null) {
			messages = new ActionMessages();
		}
		
		messages.add(property, new ActionMessage(key,args ));
		
		request.setAttribute(Globals.ERROR_KEY, messages);
	}

	/**
	 * リダイレクト先のURLを返す。
	 *
	 * @deprecated ROOTコンテキストのときリダイレクト先が//になる。
	 * @param path
	 * @return
	 */
	@Deprecated
	public String getRedirectUrl(String path) {
		if (path.contains("?")) {
			return path + "&redirect=true";
		}
		else {
			return path + "?redirect=true";
		}
	}

	/**
	 * リダイレクトする。
	 *
	 * contractUrlPathはフィルタが付加するため付けない。
	 *
	 * @param path
	 * @return
	 * @throws IOException
	 */
	public void redirect(String path) throws IOException {
		String url = "";
		url = request.getContextPath() + path;

		if (logger.isDebugEnabled()) {
			logger.debug("Redirect to: " + url);
		}
		response.sendRedirect(url);
	}

	/**
     * セッションを再作成
     * 指定された属性を引き継ぐ
     */
    protected void renewSession(String... atrNames) {
    	session = ServletUtil.renewSession(request, atrNames);
    }

    /**
     * セッションのパスをセットする
     * 
     */
    protected void setCookiePath(String path) {
    	Cookie cookie = new Cookie("JSESSIONID", session.getId());
		cookie.setPath(path);
		cookie.setMaxAge(-1); // ブラウザが開いているときのみ
		response.addCookie(cookie);
    }

	protected AuthenticatedTokenVO getMemberInfo() {
    	return	(AuthenticatedTokenVO) session.getAttribute(AttrKey.AUTHENTICATED_TOKEN);
    }

    /**
     * ログインユーザIDを取得する。
     *
     * @return ログインユーザID
     */
    protected Integer getUserId() {
		return getMemberInfo().userId;
	}

    /**
     * ログインユーザのアカウント名を取得する。
     *
     * @return ログインユーザアカウント名
     */
    protected String getLoginId() {
		return getMemberInfo().loginId;
	}

    /**
	 * キャッシュを禁止
	 *
	 */
	protected void setNoCache() {
		response.addHeader("Expires", "-1");
		response.addHeader("Cache-Control", "no-cache");
		response.addHeader("Pragma", "no-cache");
	}
	
	/**
	 * ユーザー
	 * セッション情報を確立する。
	 * @param memberInfo MemberEntity
	 * @param userType
	 */
	protected void setAuthenticatedToken(Member memberInfo,int userType){
		AuthenticatedTokenVO token = new AuthenticatedTokenVO();
		token.member = memberInfo;
		token.userType = userType;
		token.userName = memberInfo.lastName;
		
		token.userId = memberInfo.memberId;
		token.loginId= memberInfo.loginId;
		
		session.setAttribute(AttrKey.AUTHENTICATED_TOKEN, token);
		SessionBindingListener listener = new SessionBindingListener(token, application);
		session.setAttribute(SinaburoConstant.AttrKey.BINDING_LISTENER, listener);	
	}
	
	
	/**
	 * memberを取得する。
	 * @return member
	 */
	protected Member getMember() {
		Object obj = session.getAttribute(AttrKey.AUTHENTICATED_TOKEN);
		if(obj == null){
			return null;
		}
		return ((AuthenticatedTokenVO)obj).member;
	}
	
	
	/**
	 * 管理者
	 * セッション情報を確立する。
	 * @param memberInfo MemberEntity
	 * @param userType
	 */
	protected void setAuthenticatedToken(AdminUser adminUserInfo,int userType){
		AuthenticatedTokenVO token = new AuthenticatedTokenVO();
		token.adminUser = adminUserInfo;
		token.userType = userType;
		token.userName = adminUserInfo.adminUserName;
		
		token.userId = adminUserInfo.adminUserId;
		token.loginId= adminUserInfo.loginId;
		
		session.setAttribute(AttrKey.AUTHENTICATED_TOKEN, token);
		SessionBindingListener listener = new SessionBindingListener(token, application);
		session.setAttribute(SinaburoConstant.AttrKey.BINDING_LISTENER, listener);	
	}
	
	
	/**
	 * adminUserを取得する。
	 * @return acminUser
	 */
	protected AdminUser getAdmin() {
		Object obj = session.getAttribute(AttrKey.AUTHENTICATED_TOKEN);
		if(obj == null){
			return null;
		}
		return ((AuthenticatedTokenVO)obj).adminUser;
	}
	
	/**ログインしていないユーザーはログイン画面に戻す。*/
	protected String adminLoginCheckPath = "/admin/";
	/**
	 * adminUserを取得する。
	 * @return acminUser
	 */
	protected String adminLoginCheck(String returnPath) {
		Object obj = session.getAttribute(AttrKey.AUTHENTICATED_TOKEN);
		if(obj == null){
			return returnPath;
		}
		
		if(((AuthenticatedTokenVO)obj).adminUser == null){
			return returnPath;
		}
		
		return "";
	}
	
	
	
	
}