画面エラーのログ出力を整理

投稿日時: 2016年1月20日投稿者: bokusui

今作っているJavaEEアプリですが、画面エラー発生時のログ出力を検討しました。ま、アプリケーションサーバであるWebLogicが勝手にログを出してくれますが、エラー以外にも勝手に出るので量が多くて見るのが辛いし、アプリとしては別途log4j2でロギングする方向にしているので、画面エラー発生時もlog4j出力に統一するという要件になります。WebLogicでlog4jとログを連携させるとかFilter使うとかいろいろやり方はありそうでしたが、画面個々に手を入れずに最も簡単なやり方は無いかなと考えたところ、画面エラー発生時はエラーページに遷移するようにしておいて、そのエラーページでログ出力させるという形にしてみます。

web.xml抜粋（今の所・・・）

  <error-page>
    <exception-type>javax.servlet.ServletException</exception-type>
    <location>/errors/index.xhtml</location>
  </error-page>
  <error-page>
    <exception-type>javax.ejb.EJBException</exception-type>
    <location>/errors/index.xhtml</location>
  </error-page>
  <error-page>
    <error-code>403</error-code>
    <location>/errors/403.xhtml</location>
  </error-page>

<error-page>

<exception-type>javax.servlet.ServletException</exception-type>

<location>/errors/index.xhtml</location>

</error-page>

<error-page>

<exception-type>javax.ejb.EJBException</exception-type>

<location>/errors/index.xhtml</location>

</error-page>

<error-page>

<error-code>403</error-code>

<location>/errors/403.xhtml</location>

</error-page>

エラーページ用JSF管理Bean

@ManagedBean(name="errorPage")
public class ErrorHander {
	protected static Logger logger=LogManager.getLogger();
	private String message;
	
	/** エラーメッセージ出力 */
	public String getMessage() {
        FacesContext context = FacesContext.getCurrentInstance();
        ExternalContext externalContext = context.getExternalContext();
        HttpServletRequest request = (HttpServletRequest) externalContext.getRequest();

		String errorURI = 
				(String) request.getAttribute("javax.servlet.error.request_uri");

		message = (String)request.getAttribute("javax.servlet.error.message");
		Throwable throwable = (Throwable) 
				request.getAttribute("javax.servlet.error.exception");

		logger.error("View Error URL={}", errorURI, throwable);
		return message;
	}

	public void setMessage(String message) {
		this.message = message;
	}
}

@ManagedBean(name="errorPage")

public class ErrorHander {

protected static Logger logger=LogManager.getLogger();

private String message;

/** エラーメッセージ出力 */

public String getMessage() {

FacesContext context = FacesContext.getCurrentInstance();

ExternalContext externalContext = context.getExternalContext();

HttpServletRequest request = (HttpServletRequest) externalContext.getRequest();

String errorURI =

(String) request.getAttribute("javax.servlet.error.request_uri");

message = (String)request.getAttribute("javax.servlet.error.message");

Throwable throwable = (Throwable)

request.getAttribute("javax.servlet.error.exception");

logger.error("View Error URL={}", errorURI, throwable);

return message;

}

public void setMessage(String message) {

this.message = message;

}

最後にweb.xmlで指定した/errors/index.xhtmlで、エラー内容は見せないように下記を忍ばせておけば、管理Beanのメソッドが実行されるという形になります。

<h:outputLabel id="execMsg" value="#{errorPage.message}" style="visibility:hidden;"/>

1	<h:outputLabel id="execMsg" value="#{errorPage.message}" style="visibility:hidden;"/>

要件はちゃんと確認しないと・・・VFSで作り直し

投稿日時: 2015年12月23日投稿者: bokusui

ちょっと前に書いたログファイルをダウンロードする機能ですが、実機となるLINUX上にデプロイすると動きませんでした。。。サーバへ接続はできているようなのですが瞬時に切断されているようです。原因切り分けの為、作業中に使っているユーザーIDで試してみると特に問題無く動いてます。TeraTermから指定のIDでログインしてみると即切断されたようになり、WinSCPでSFTPログインすると問題無くアクセスできます。
　で、要件を思い出すと、「SFTPはOK」ではなく、「SFTPのみOK」であった事に気が付きました。与えられたユーザーIDでは、SSH接続ができないセキュリティ設定になっていたという事なんです。（sshd_configでSFTP専用にされてました）
　要件上はたった２文字の違いですが、実装上は明らかに別物であり、SSHで接続するような実装ではNGという事になります。
　となるとGamynedのようにSSHを前提にしたライブラリでなく、SFTPのみでサーバへアクセスできるライブラリを探し、ApacheCommonsのVFSに落ち着きました。なお、VSFにはJschが必要みたいです。
　login,logoutはなさそうなんで、ManagedBeanの呼び出しメソッド引数にID、パスワード、ホスト名を追加して、SFTP処理クラスが殆どの変更箇所となります。とりあえず、ファイル受信は出来ましたので別途整理します。

  <dependencies>
	<dependency>
		<groupId>org.apache.commons</groupId>
		<artifactId>commons-vfs2</artifactId>
		<version>2.0</version>
	</dependency>
	<dependency>
		<groupId>com.jcraft</groupId>
		<artifactId>jsch</artifactId>
		<version>0.1.53</version>
	</dependency>
	<dependency>
		<groupId>org.apache.commons</groupId>
		<artifactId>commons-lang3</artifactId>
		<version>3.4</version>
	</dependency>
  </dependencies>

<groupId>org.apache.commons</groupId>

<artifactId>commons-vfs2</artifactId>

</dependency>

<groupId>com.jcraft</groupId>

</dependency>

<groupId>org.apache.commons</groupId>

<artifactId>commons-lang3</artifactId>

</dependency>

</dependencies>

import org.apache.commons.lang3.StringUtils;
import org.apache.commons.lang3.time.DateFormatUtils;
import org.apache.commons.vfs2.FileObject;
import org.apache.commons.vfs2.FileSystemManager;
import org.apache.commons.vfs2.FileSystemOptions;
import org.apache.commons.vfs2.FileType;
import org.apache.commons.vfs2.VFS;
import org.apache.commons.vfs2.provider.sftp.SftpFileSystemConfigBuilder;

/**
 * SFTPファイルアクセスクラス by apache commons vfs
 * */
@Stateless
public class SFTPFileAccess {
	
	public SFTPFileAccess(){
	}

	/**
	 * リモートホスト上の指定ディレクトリのファイル一覧を取得する
	 * @param String RemoteDir ディレクトリ名
	 * @param List<LogFile> セットするファイル一覧
	 * @param String User ユーザーID
	 * @param String Password パスワード
	 * @param String HostName ホスト名
	 * @throws IOException
	 * */
	public void getSFTPList(String RemoteDir, List<LogFile> FileList, String User, String Password, String HostName) throws IOException {

		FileSystemOptions opts = new FileSystemOptions();
		SftpFileSystemConfigBuilder.getInstance().setStrictHostKeyChecking(opts, "no");
		FileSystemManager fsManager = VFS.getManager();
		
    	String URL = "sftp://"+URLEncoder.encode(User, "UTF-8");
    	
    	URL = URL +":" + URLEncoder.encode(Password, "UTF-8");
    	URL = URL +"@" + URLEncoder.encode(HostName, "UTF-8");
    	URL = URL + RemoteDir;
    	
		FileObject localFileObject=fsManager.resolveFile(URL);
		
		//Directoryチェック
		if ( !localFileObject.getType().equals(FileType.FOLDER) ){
			return;
		}
		//ファイル存在チェック
		if( ! localFileObject.getType().hasChildren() ){
			return;
		}

		FileObject[] children = localFileObject.getChildren();
        for (int i = 0; i < children.length; i++) {
        	if(StringUtils.isEmpty(children[ i ].getName().getBaseName())){
	        	LogFile file = new LogFile();
	        	file.setFileName(children[ i ].getName().getBaseName());
	        	file.setDirectory(RemoteDir);
	        	file.setFileSize(children[ i ].getContent().getSize());
	        	Date tm = new Date(children[ i ].getContent().getLastModifiedTime());
	        	file.setUpDateTime(DateFormatUtils.format(tm, "yyyy/MM/dd HH:mm:ss"));
	        	FileList.add(file);
        	}
        }
    }
    /**
     * SFTPファイル受信
     * @param remoteFile　受信元ファイル
     * @param stream ストリーム
     * @param String User ユーザーID
     * @param String Password パスワード
     * @param String HostName ホスト名
     * */
    public void getFile( String remoteFile, OutputStream stream, String User, String Password, String HostName) throws IOException{
		FileSystemOptions opts = new FileSystemOptions();

		SftpFileSystemConfigBuilder.getInstance().setStrictHostKeyChecking(opts, "no");
		FileSystemManager fsManager = VFS.getManager();
        
		String URL = "sftp://"+URLEncoder.encode(User, "UTF-8");
    	URL = URL +":" + URLEncoder.encode(Password, "UTF-8");
    	URL = URL +"@" + URLEncoder.encode(HostName, "UTF-8");
    	URL = URL + remoteFile;
    	
		FileObject localFileObject = fsManager.resolveFile(URL);
		
		if(!localFileObject.exists()){
			throw new IOException(); 
		}
		
		InputStream inputStream = localFileObject.getContent().getInputStream();

		BufferedOutputStream bos = new BufferedOutputStream(stream);
        
        byte[] buffer = new byte[1024];
        int readLength = 0;
        
        while( (readLength = inputStream.read(buffer)) != -1){
          bos.write(buffer, 0, readLength);
        }
        // close
        inputStream.close();
        bos.close();
    }
}

100

101

102

103

import org.apache.commons.lang3.StringUtils;

import org.apache.commons.lang3.time.DateFormatUtils;

import org.apache.commons.vfs2.FileObject;

import org.apache.commons.vfs2.FileSystemManager;

import org.apache.commons.vfs2.FileSystemOptions;

import org.apache.commons.vfs2.FileType;

import org.apache.commons.vfs2.VFS;

import org.apache.commons.vfs2.provider.sftp.SftpFileSystemConfigBuilder;

/**

* SFTPファイルアクセスクラス by apache commons vfs

* */

@Stateless

public class SFTPFileAccess {

public SFTPFileAccess(){

}

/**

* リモートホスト上の指定ディレクトリのファイル一覧を取得する

* @param String RemoteDir ディレクトリ名

* @param List<LogFile> セットするファイル一覧

* @param String User ユーザーID

* @param String Password パスワード

* @param String HostName ホスト名

* @throws IOException

* */

public void getSFTPList(String RemoteDir, List<LogFile> FileList, String User, String Password, String HostName) throws IOException {

FileSystemOptions opts = new FileSystemOptions();

SftpFileSystemConfigBuilder.getInstance().setStrictHostKeyChecking(opts, "no");

FileSystemManager fsManager = VFS.getManager();

String URL = "sftp://"+URLEncoder.encode(User, "UTF-8");

URL = URL +":" + URLEncoder.encode(Password, "UTF-8");

URL = URL +"@" + URLEncoder.encode(HostName, "UTF-8");

URL = URL + RemoteDir;

FileObject localFileObject=fsManager.resolveFile(URL);

//Directoryチェック

if ( !localFileObject.getType().equals(FileType.FOLDER) ){

return;

}

//ファイル存在チェック

if( ! localFileObject.getType().hasChildren() ){

return;

}

FileObject[] children = localFileObject.getChildren();

for (int i = 0; i < children.length; i++) {

if(StringUtils.isEmpty(children[ i ].getName().getBaseName())){

LogFile file = new LogFile();

file.setFileName(children[ i ].getName().getBaseName());

file.setDirectory(RemoteDir);

file.setFileSize(children[ i ].getContent().getSize());

Date tm = new Date(children[ i ].getContent().getLastModifiedTime());

file.setUpDateTime(DateFormatUtils.format(tm, "yyyy/MM/dd HH:mm:ss"));

FileList.add(file);

}

/**

* SFTPファイル受信

* @param remoteFile　受信元ファイル

* @param stream ストリーム

* @param String User ユーザーID

* @param String Password パスワード

* @param String HostName ホスト名

* */

public void getFile( String remoteFile, OutputStream stream, String User, String Password, String HostName) throws IOException{

FileSystemOptions opts = new FileSystemOptions();

SftpFileSystemConfigBuilder.getInstance().setStrictHostKeyChecking(opts, "no");

FileSystemManager fsManager = VFS.getManager();

String URL = "sftp://"+URLEncoder.encode(User, "UTF-8");

URL = URL +":" + URLEncoder.encode(Password, "UTF-8");

URL = URL +"@" + URLEncoder.encode(HostName, "UTF-8");

URL = URL + remoteFile;

FileObject localFileObject = fsManager.resolveFile(URL);

if(!localFileObject.exists()){

throw new IOException();

}

InputStream inputStream = localFileObject.getContent().getInputStream();

BufferedOutputStream bos = new BufferedOutputStream(stream);

byte[] buffer = new byte[1024];

int readLength = 0;

while( (readLength = inputStream.read(buffer)) != -1){

bos.write(buffer, 0, readLength);

}

// close

inputStream.close();

bos.close();

}

bootstrapのdatepickerを使ってみる

投稿日時: 2015年12月9日投稿者: bokusui

前回、今作成中のWebLogicアプリにbootstrapを使う事にしたので、次は日付入力にdatepickerを使ってみることにしました。datepickerって、使う方も入力しやすいし、作る方も余計な日付チェック処理を作らなくて済むし、素晴らしいコンポーネントだと思います。昔はテキスト入力エリアを年/月/日と３個繋げて、日付妥当性やメンドクサイうるう年チェックとかしてたんですよ・・・
しかも、ダウンロードURLではオプション設定の書き方も教えてくれてます。
bootstrap-datepicker
JSF2画面xhtmlの該当箇所は下記ですが、そのままだとBean側が更新されないので、f:ajaxで通知してます。

<h:outputStylesheet name="bootstrap/css/bootstrap-datepicker.min.css" />
<h:outputScript name="bootstrap/js/bootstrap-datepicker.min.js" />
<h:outputScript name="bootstrap/js/bootstrap-datepicker.ja.min.js" />
<script type="text/javascript">
$(function() {
  $('.datepicker').datepicker({
    language: 'ja',
    format: 'yyyy/mm/dd',
    autoclose: true,
    todayHighlight: true
  });
});
</script>
・・・中略
          <h:inputText value="#{bean.inDate}" class="from-control datepicker" >
             <f:ajax  execute="@this"/>
          </h:inputText>
・・・以下省略

<h:outputStylesheet name="bootstrap/css/bootstrap-datepicker.min.css" />

<h:outputScript name="bootstrap/js/bootstrap-datepicker.min.js" />

<h:outputScript name="bootstrap/js/bootstrap-datepicker.ja.min.js" />

$(function() {

$('.datepicker').datepicker({

language: 'ja',

format: 'yyyy/mm/dd',

autoclose: true,

todayHighlight: true

});

</script>

・・・中略

<h:inputText value="#{bean.inDate}" class="from-control datepicker" >

<f:ajax execute="@this"/>

</h:inputText>

・・・以下省略

画面メニューにbootstrapのnavbarを使ってみる

投稿日時: 2015年12月3日投稿者: bokusui

今作っているWebアプリですが、ログインユーザー権限によりメニューのリンク表示を切り替える要件の実装について、一緒に作ってるメンバーに聞いてみたら、bootstrapのnavbarがかっこいいとの事で使ってみました。
各画面で指定するテンプレートxhtmlにbootstrapのnavbarをセットする形です。なお、bootstrapのバージョンは少し古いですが2.3.2を使ってます。
bootstrapをダウンロードしたら、Webソース内のresourcesにダウンロードした各ディレクトリを入れ、メニューを表示する各画面xhtmlでは、下記のようにテンプレートを指定します。

<ui:composition template="../templates/menu.xhtml">

1	<ui:composition template="../templates/menu.xhtml">

テンプレートとして指定したmenu.xhtmlですが、その中の「SessionManager」はログイン情報を保持しているSessionScopedBeanで、ログイン時にログイン日時をlogintimeに、各権限の値をroleCdにセットし、xhtml側ではui:fragmentのrenderedで表示を切り替えます。

<h:outputStylesheet name="bootstrap/css/bootstrap.css" />
<h:outputStylesheet name="bootstrap/css/bootstrap-responsive.css" />
<h:outputScript name="bootstrap/js/bootstrap.js" />
<h:body>
  <nav class="navbar navbar-inverse navbar-default">
    <div class="navbar-inner">
    <div id="container">
      <h:form>
        <ul class="nav navbar-nav">
          <ui:fragment rendered="#{SessionManager.roleCd == 1}">
            <li><a href="../sales/page1.xhtml">ファイル照会</a></li>
            <li><a href="../sales/page2.xhtml">状態確認</a></li>
            <li><a href="../common/pwchange.xhtml">パスワード更新</a></li>
          </ui:fragment>
          <ui:fragment rendered="#{SessionManager.roleCd == 2}">
            <li><a href="../usermanage/page1.xhtml">ユーザー管理</a></li>
            <li><a href="../usermanage/page2.xhtml">ユーザー一覧</a></li>
            <li><a href="../common/pwchange.xhtml">パスワード更新</a></li>
          </ui:fragment>
・・・他の設定は割愛
          <ui:insert name="navlinks" ></ui:insert>
        </ul>
        <h:commandButton class="btn btn-primary btn-lg pull-right" value="ログアウト" action="#{SessionManager.logout}" />
        <h:outputText class="span3 pull-right" style="color: #ffffff;" value="#{SessionManager.logintime}"/>
        </h:form>
      <ui:insert name="navinfo"/>
    </div>
    </div>
  </nav>

<h:outputStylesheet name="bootstrap/css/bootstrap.css" />

<h:outputStylesheet name="bootstrap/css/bootstrap-responsive.css" />

<h:outputScript name="bootstrap/js/bootstrap.js" />

<h:body>

<h:form>

<ui:fragment rendered="#{SessionManager.roleCd == 1}">

<li><a href="../sales/page1.xhtml">ファイル照会</a></li>

<li><a href="../common/pwchange.xhtml">パスワード更新</a></li>

</ui:fragment>

<ui:fragment rendered="#{SessionManager.roleCd == 2}">

<li><a href="../usermanage/page1.xhtml">ユーザー管理</a></li>

<li><a href="../usermanage/page2.xhtml">ユーザー一覧</a></li>

<li><a href="../common/pwchange.xhtml">パスワード更新</a></li>

</ui:fragment>

・・・他の設定は割愛

<ui:insert name="navlinks" ></ui:insert>

</ul>

<h:commandButton class="btn btn-primary btn-lg pull-right" value="ログアウト" action="#{SessionManager.logout}" />

<h:outputText class="span3 pull-right" style="color: #ffffff;" value="#{SessionManager.logintime}"/>

</h:form>

<ui:insert name="navinfo"/>

</div>

</nav>

ログインした権限に従い下記のようにメニューを表示されます。

JSF2カスタムコンバータでデコードしつつdataTableの背景を変える

投稿日時: 2015年11月18日投稿者: bokusui

今作っているWEBアプリで、画面に一覧を表示して、一覧表示内の項目値によって背景色を変えたいという要件がありました。
で、JSF2のカスタムコンバータを使って、コード値を文言にデコードしつつ、裏でCSSクラスを変えることで背景色が動的に変わる形にしてみました。コンバータは一つで、どのコード体系でデコードするかは、attributeでコンバータに情報を渡す構成になってます、とりあえずは。。

CSS抜粋

.listTable th {
	font-weight: normal;
	color: #ffffff;
	background-color: #339933;
	text-align: center;
	padding: 1px;
	border-right-style: solid;
	border-bottom-style: solid;
	border-right-color: #CCCCCC;
	border-bottom-color: #CCCCCC;
	font-size: 10pt;
	white-space: nowrap;
}

.listTable td {
	padding: 1px;
	background-color: #ffffff;
	border-right-style: solid;
	border-bottom-style: solid;
	border-right-color: #CCCCCC;
	border-bottom-color: #CCCCCC;
	font-size: 11pt;
}

/* 警告表示 */
.cError {
	background-color: #ff0000;
	color: #ffffff;
 	display:block;
}
/* 一部異常表示 */
.cCaution {
	background-color: #ffff00;
 	display:block;
}

/* 対象外表示 */
.cNoTaget {
 	background-color: #a4a4a4;
 	display:block;
}

/* 通常表示 */
.cDefault {
	background-color: #ffffff;
 	display:block;
}

.listTable th {

font-weight: normal;

color: #ffffff;

background-color: #339933;

text-align: center;

padding: 1px;

border-right-style: solid;

border-bottom-style: solid;

border-right-color: #CCCCCC;

border-bottom-color: #CCCCCC;

font-size: 10pt;

white-space: nowrap;

}

.listTable td {

padding: 1px;

background-color: #ffffff;

border-right-style: solid;

border-bottom-style: solid;

border-right-color: #CCCCCC;

border-bottom-color: #CCCCCC;

font-size: 11pt;

}

/* 警告表示 */

.cError {

background-color: #ff0000;

color: #ffffff;

display:block;

}

/* 一部異常表示 */

.cCaution {

background-color: #ffff00;

display:block;

}

/* 対象外表示 */

.cNoTaget {

background-color: #a4a4a4;

display:block;

}

/* 通常表示 */

.cDefault {

background-color: #ffffff;

display:block;

}

xhtmlのdataTable部分抜粋
※wordsはwords.propertiesのファイル側に定義している項目タイトルの文言です

    <h:dataTable id="Info" var="list" value="#{listView.itemlist}" styleClass="listTable">
      <h:column>
        <f:facet name="header" >#{words.Label_coName}</f:facet>
        <h:outputText value="#{list.coName}"/>
      </h:column>
      <h:column>
        <f:facet name="header" >#{words.Label_coCode}</f:facet>
        <h:outputText value="#{list.coCode}"/>
      </h:column>
      <h:column>
        <f:facet name="header" >#{words.Label_status1}</f:facet>
        <h:outputText value="#{list.status1}">
          <f:converter converterId="statusConverter"/>
          <f:attribute name="ConvertType" value="1"/>
        </h:outputText>
      </h:column>
      <h:column>
        <f:facet name="header" >#{words.Label_status2}</f:facet>
        <h:outputText value="#{list.status2}">
          <f:converter converterId="statusConverter"/>
          <f:attribute name="ConvertType" value="2"/>
        </h:outputText>
      </h:column>
以下省略

    </h:dataTable>

<h:dataTable id="Info" var="list" value="#{listView.itemlist}" styleClass="listTable">

<h:column>

<f:facet name="header" >#{words.Label_coName}</f:facet>

<h:outputText value="#{list.coName}"/>

</h:column>

<h:column>

<f:facet name="header" >#{words.Label_coCode}</f:facet>

<h:outputText value="#{list.coCode}"/>

</h:column>

<h:column>

<f:facet name="header" >#{words.Label_status1}</f:facet>

<h:outputText value="#{list.status1}">

<f:converter converterId="statusConverter"/>

<f:attribute name="ConvertType" value="1"/>

</h:outputText>

</h:column>

<h:column>

<f:facet name="header" >#{words.Label_status2}</f:facet>

<h:outputText value="#{list.status2}">

<f:converter converterId="statusConverter"/>

<f:attribute name="ConvertType" value="2"/>

</h:outputText>

</h:column>

以下省略

</h:dataTable>

カスタムコンバータ

@FacesConverter(value="statusConverter")
public class StatusConverter implements Converter {

	private static final String DEFVALUE = "X";

	private static final String DEFAULT = "cDefault";
	private static final String NOTARGET = "cNoTaget";
	private static final String CAUTION = "cCaution";
	private static final String ERROR = "cError";
	
	// ConvertType 1 OKNG表示
	private static final Map<String, String> OkNgState;
	static {
		HashMap<String, String> map = new HashMap<String, String>();
		map.put(DEFVALUE, "-");
		map.put("1", "OK");
		map.put("2", "NG");
		OkNgState = Collections.unmodifiableMap(map);
	}
	// ConvertType 2 現在状況表示
	private static final Map<String, String> NowState;
	static {
		HashMap<String, String> map = new HashMap<String, String>();
		map.put(DEFVALUE, "-");
		map.put("0", "処理前");
		map.put("1", "仕掛中");
		map.put("2", "処理済");
		NowState = Collections.unmodifiableMap(map);
	}
	// ConvertType 3 結果表示
	private static final Map<String, String> ResStatus;
	static {
		HashMap<String, String> map = new HashMap<String, String>();
		map.put(DEFVALUE, "-");
		map.put("0", "正常");
		map.put("1", "異常");
		map.put("2", "警告");
		ResStatus = Collections.unmodifiableMap(map);
	}
	//警告表示対象
	private static final Map<String, String> Caution;
	static {
		HashMap<String, String> map = new HashMap<String, String>();
		map.put("異常", ERROR);
		map.put("警告", CAUTION);
		map.put("-", NOTARGET);
		Caution = Collections.unmodifiableMap(map);
	}

	@Override
	public String getAsString(FacesContext arg0, UIComponent arg1, Object arg2) {
		String DispValue="";
		String InnerValue = (String) arg2;
		String StyleClass = DEFAULT;
		
		Map<String,String> ConvertMap = null;
		Map<String,Object> attrMap = arg1.getAttributes();
		
		//f:attribute より変換タイプを取得
		String type = (String)attrMap.get("ConvertType");
		if (! StringUtils.isNumeric(type) ){
			return "";
		}

		switch (Integer.valueOf(type)){
			case 1:
				ConvertMap = OkNgState;
				break;
			case 2:
				ConvertMap = NowState;
				break;
			case 3:
				ConvertMap = ResStatus;
				break;
			default:
				DispValue = InnerValue;
				ConvertMap = null;
				break;
				
		}
		//デコード
		if(ConvertMap != null){
			DispValue = ConvertMap.get(InnerValue);
			//初期値
			if (DispValue == null ){
				DispValue = ConvertMap.get(DEFVALUE);
			}
		}
		//スタイルクラス指定
		if(Caution.get(DispValue) != null){
				StyleClass = Caution.get(DispValue);
			}
		}
		//色変
		if (arg1.getClass() == HtmlOutputText.class){
			HtmlOutputText ui = (HtmlOutputText) arg1;
			ui.setStyleClass(StyleClass);
		}
		return DispValue;
	}
	//こっちは関係無し
	@Override
	public Object getAsObject(FacesContext arg0, UIComponent arg1, String arg2) {
		return null;
	}
}

100

101

102

103

104

105

106

@FacesConverter(value="statusConverter")

public class StatusConverter implements Converter {

private static final String DEFVALUE = "X";

private static final String DEFAULT = "cDefault";

private static final String NOTARGET = "cNoTaget";

private static final String CAUTION = "cCaution";

private static final String ERROR = "cError";

// ConvertType 1 OKNG表示

private static final Map<String, String> OkNgState;

static {

HashMap<String, String> map = new HashMap<String, String>();

map.put(DEFVALUE, "-");

map.put("1", "OK");

map.put("2", "NG");

OkNgState = Collections.unmodifiableMap(map);

}

// ConvertType 2 現在状況表示

private static final Map<String, String> NowState;

static {

HashMap<String, String> map = new HashMap<String, String>();

map.put(DEFVALUE, "-");

map.put("0", "処理前");

map.put("1", "仕掛中");

map.put("2", "処理済");

NowState = Collections.unmodifiableMap(map);

}

// ConvertType 3 結果表示

private static final Map<String, String> ResStatus;

static {

HashMap<String, String> map = new HashMap<String, String>();

map.put(DEFVALUE, "-");

map.put("0", "正常");

map.put("1", "異常");

map.put("2", "警告");

ResStatus = Collections.unmodifiableMap(map);

}

//警告表示対象

private static final Map<String, String> Caution;

static {

HashMap<String, String> map = new HashMap<String, String>();

map.put("異常", ERROR);

map.put("警告", CAUTION);

map.put("-", NOTARGET);

Caution = Collections.unmodifiableMap(map);

}

@Override

public String getAsString(FacesContext arg0, UIComponent arg1, Object arg2) {

String DispValue="";

String InnerValue = (String) arg2;

String StyleClass = DEFAULT;

Map<String,String> ConvertMap = null;

Map<String,Object> attrMap = arg1.getAttributes();

//f:attribute より変換タイプを取得

String type = (String)attrMap.get("ConvertType");

if (! StringUtils.isNumeric(type) ){

return "";

}

switch (Integer.valueOf(type)){

case 1:

ConvertMap = OkNgState;

break;

case 2:

ConvertMap = NowState;

break;

case 3:

ConvertMap = ResStatus;

break;

default:

DispValue = InnerValue;

ConvertMap = null;

break;

}

//デコード

if(ConvertMap != null){

DispValue = ConvertMap.get(InnerValue);

//初期値

if (DispValue == null ){

DispValue = ConvertMap.get(DEFVALUE);

}

//スタイルクラス指定

if(Caution.get(DispValue) != null){

StyleClass = Caution.get(DispValue);

}

//色変

if (arg1.getClass() == HtmlOutputText.class){

HtmlOutputText ui = (HtmlOutputText) arg1;

ui.setStyleClass(StyleClass);

}

return DispValue;

}

//こっちは関係無し

@Override

public Object getAsObject(FacesContext arg0, UIComponent arg1, String arg2) {

return null;

}

ManagedBean抜粋
※一覧表示対象のitemInfoの実装は割愛します。プロパティとゲッタ・セッタがあるだけです。。

@ManagedBean(name="listView")
@ViewScoped
public class ListView {
	private List<itemInfo> itemlist;

	public List<itemInfo> getitemlist() {
		//ここでitemlistのデータをセットしてますが省略します
		return itemlist;
	}
以下、省略

@ManagedBean(name="listView")

@ViewScoped

public class ListView {

private List<itemInfo> itemlist;

public List<itemInfo> getitemlist() {

//ここでitemlistのデータをセットしてますが省略します

return itemlist;

}

以下、省略

こんな感じで表示できそうなので、別途整理して実装します。
上記例では色が変わるのは行でなくセル単位になります。なお、dataTableの場合、その中のoutputTextはdivに置き換えらえるようなので、コンバータではtdのスタイルを変えているのではなくdivが対象になってます。それをCSSでカバーしているのですが、CSSは得意でないので。。

ganymed ssh2を使ってダウンロード画面を作る

投稿日時: 2015年11月9日投稿者: bokusui

今作っているWebアプリケーションでサーバのログファイルをダウンロードしたいという要件があり、そこでganymedを使ってみることにしました。アプリケーションをデプロイしているサーバとは別に複数存在するサーバ上にあるログファイルを画面から選択してクリックでダウンロードという流れです。
　なお、サーバとログファイルが格納されているディレクトリ情報は別途ＤＢ等から取る形にして、下記はSFTPでファイルを取得する箇所の抜粋です。

POM.xml ganymed指定

    <dependency>
	  <groupId>ch.ethz.ganymed</groupId>
	  <artifactId>ganymed-ssh2</artifactId>
	  <version>262</version>
     </dependency>

<groupId>ch.ethz.ganymed</groupId>

<artifactId>ganymed-ssh2</artifactId>

</dependency>

画面に表示するログファイル情報

public class LogFile {
	
	/** ファイル名 */
	private String fileName;
	
	/** 更新日時 */
	private String upDateTime;
	
	/** ディレクトリ */
	private String directory;
	
	/** サイズ */
	private long fileSize;
	
	/** ホスト名 */
	private String hostName;

以下、ゲッタとセッタは割愛

public class LogFile {

/** ファイル名 */

private String fileName;

/** 更新日時 */

private String upDateTime;

/** ディレクトリ */

private String directory;

/** サイズ */

private long fileSize;

/** ホスト名 */

private String hostName;

以下、ゲッタとセッタは割愛

SFTP処理
※サーバは一般的なID・パスワード認証です。

import ch.ethz.ssh2.Connection;
import ch.ethz.ssh2.SFTPv3Client;
import ch.ethz.ssh2.SFTPv3DirectoryEntry;
import ch.ethz.ssh2.SFTPv3FileHandle;

/**
 * SFTPファイルアクセスクラス by Ganymed SSH-2
 * */
@Stateless
public class SFTPFileAccess {
	private final int PORT = 22;
	private SFTPv3Client sftp = null;
	private Connection conn = null;
	
	/**
	 * リモートホストへログインします
	 * @param HostName リモートホスト名
	 * @param User ログインユーザー名
	 * @param Password ログインパスワード
	 * @throws IOException 
	 * 
	 * */
	public boolean loginHost(String HostName, String User, String Password) throws IOException{
		conn = new Connection(HostName, PORT);

		conn.connect();
        if (!conn.authenticateWithPassword(User, Password)) {
        	//エラー
        	return false;
        }
        return true;
	}
	
	/**
	 * リモートホスト接続をクローズします
	 * @throws IOException 
	 * 
	 * */
	public void logOutHost() throws IOException{
		if(conn != null){
			conn.close();
		}
        return;
	}

	/**
	 * リモートホスト上の指定ディレクトリのファイル一覧を取得する
	 * @param String RemoteDir ディレクトリ名
	 * @param List<LogFile> セットするファイル一覧
	 * @throws IOException
	 * */
	public void getSFTPList(String RemoteDir, List<LogFile> FileList) throws IOException {
		if(conn == null){
			return;
		}
        sftp = new SFTPv3Client(conn);
        
		List<SFTPv3DirectoryEntry> DirList = sftp.ls(RemoteDir);
		if ( FileList == null ){
			FileList = new ArrayList<LogFile>();
		}
        for (SFTPv3DirectoryEntry Entry : DirList ){
        	//ディレクトリ以外
        	if (!Entry.longEntry.startsWith("d") ){
	        	LogFile file = new LogFile();
	        	file.setDirectory(RemoteDir);
	        	file.setFileName(Entry.filename);
	        	file.setHostName(conn.getHostname());
	        	file.setFileSize(Entry.attributes.size);
                //ファイル更新時間
	        	Date tm = new Date(Entry.attributes.mtime * 1000L);
	        	file.setUpDateTime(DateUtils.format(tm, DateUtils.FORMAT_YYYY_MM_DD_HH_MM_SS));
	        	FileList.add(file);
	    		
        	}
        }
        return;
	}

    /**
     * SFTPファイル受信
     * @param remoteFile　受信元ファイル
     * @param stream　出力ストリーム
     * 
     * */
    public void getFile( String remoteFile, OutputStream stream) throws IOException{
		if(conn == null){
			return;
		}
    	if(sftp == null){
            sftp = new SFTPv3Client(conn);
    	}
        long remoteFileSize = sftp.stat(remoteFile).size;
        // open remote file with read only
        SFTPv3FileHandle sftpFileHandle = sftp.openFileRO(remoteFile);
        
        BufferedOutputStream bos = new BufferedOutputStream(stream);
        		
        byte[] buffer = new byte[1024];
        long offset = 0;
        int readLength = 0;
        while( (readLength = sftp.read(sftpFileHandle, offset, buffer, 0, buffer.length)) != -1){
          bos.write(buffer, 0, readLength);
          offset += readLength;
        }
        // flush & Close
        bos.flush();
        bos.close();
        sftp.closeFile(sftpFileHandle);
        
        // compare
        if (offset == remoteFileSize) {
        } else {
        	System.out.println("failed: file size is different from remote. remote:" + 
              remoteFileSize+", local:"+offset);
        }
        return;
    }
}

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

import ch.ethz.ssh2.Connection;

import ch.ethz.ssh2.SFTPv3Client;

import ch.ethz.ssh2.SFTPv3DirectoryEntry;

import ch.ethz.ssh2.SFTPv3FileHandle;

/**

* SFTPファイルアクセスクラス by Ganymed SSH-2

* */

@Stateless

public class SFTPFileAccess {

private final int PORT = 22;

private SFTPv3Client sftp = null;

private Connection conn = null;

/**

* リモートホストへログインします

* @param HostName リモートホスト名

* @param User ログインユーザー名

* @param Password ログインパスワード

* @throws IOException

* */

public boolean loginHost(String HostName, String User, String Password) throws IOException{

conn = new Connection(HostName, PORT);

conn.connect();

if (!conn.authenticateWithPassword(User, Password)) {

//エラー

return false;

}

return true;

}

/**

* リモートホスト接続をクローズします

* @throws IOException

* */

public void logOutHost() throws IOException{

if(conn != null){

conn.close();

}

return;

}

/**

* リモートホスト上の指定ディレクトリのファイル一覧を取得する

* @param String RemoteDir ディレクトリ名

* @param List<LogFile> セットするファイル一覧

* @throws IOException

* */

public void getSFTPList(String RemoteDir, List<LogFile> FileList) throws IOException {

if(conn == null){

return;

}

sftp = new SFTPv3Client(conn);

List<SFTPv3DirectoryEntry> DirList = sftp.ls(RemoteDir);

if ( FileList == null ){

FileList = new ArrayList<LogFile>();

}

for (SFTPv3DirectoryEntry Entry : DirList ){

//ディレクトリ以外

if (!Entry.longEntry.startsWith("d") ){

LogFile file = new LogFile();

file.setDirectory(RemoteDir);

file.setFileName(Entry.filename);

file.setHostName(conn.getHostname());

file.setFileSize(Entry.attributes.size);

//ファイル更新時間

Date tm = new Date(Entry.attributes.mtime * 1000L);

file.setUpDateTime(DateUtils.format(tm, DateUtils.FORMAT_YYYY_MM_DD_HH_MM_SS));

FileList.add(file);

}

return;

}

/**

* SFTPファイル受信

* @param remoteFile　受信元ファイル

* @param stream　出力ストリーム

* */

public void getFile( String remoteFile, OutputStream stream) throws IOException{

if(conn == null){

return;

}

if(sftp == null){

sftp = new SFTPv3Client(conn);

}

long remoteFileSize = sftp.stat(remoteFile).size;

// open remote file with read only

SFTPv3FileHandle sftpFileHandle = sftp.openFileRO(remoteFile);

BufferedOutputStream bos = new BufferedOutputStream(stream);

byte[] buffer = new byte[1024];

long offset = 0;

int readLength = 0;

while( (readLength = sftp.read(sftpFileHandle, offset, buffer, 0, buffer.length)) != -1){

bos.write(buffer, 0, readLength);

offset += readLength;

}

// flush & Close

bos.flush();

bos.close();

sftp.closeFile(sftpFileHandle);

// compare

if (offset == remoteFileSize) {

} else {

System.out.println("failed: file size is different from remote. remote:" +

remoteFileSize+", local:"+offset);

}

return;

}

画面処理
※HttpServletResponseのOutputStreamに直ファイルを突っ込むので、一時ファイルを置いたりしません。

/**
 * ログダウンロード画面
 * */
@ManagedBean(name="LogDownload")
@SessionScoped
public class LogDownload implements Serializable {
	private static final long serialVersionUID = 1L;

	protected static Logger logger = LogManager.getLogger();
	
    @EJB
    private SFTPFileAccess ftp;
    
    private String selectedServer;

    private List<LogFile> fileList;
    
	public LogDownload() {
		fileList = new ArrayList<LogFile>();
	}

	public List<LogFile> getFileList() {
		return fileList;
	}

	public void setFileList(List<LogFile> fileList) {
		this.fileList = fileList;
	}

	public String getSelectedServer() {
		return this.selectedServer;
	}

	public void setSelectedServer(String selectedServer) {
		this.selectedServer = selectedServer;
	}

	/**
	 * ディレクトリ選択時にファイル一覧を取得
	 * */
	public void getList(){
		try {
			Map<String,String> params = FacesContext.getCurrentInstance().getExternalContext().getRequestParameterMap();
			String fileDir = params.get("fileDir");

			ftp.loginHost(selectedServer, dao.getServerLoginUser(selectedServer), dao.getServerLoginPasswd(selectedServer));
			
			fileList.clear();
			ftp.getSFTPList(fileDir,fileList);
			
		} catch (IOException e) {
			e.printStackTrace();
		}
	}
	/**
	 * ファイルダウンロード
	 * */
	public void getFile(){
		Map<String,String> params = FacesContext.getCurrentInstance().getExternalContext().getRequestParameterMap();
		String fileName = params.get("fileName");
		String fileDir = params.get("fileDir");
	  
		try {
			HttpServletResponse response = (HttpServletResponse) FacesContext.getCurrentInstance() .getExternalContext().getResponse();
			response.setContentType("application/octet-stream");
			response.setHeader("Content-Disposition", "attachment;filename=" + fileName);

			OutputStream a = response.getOutputStream();
			ftp.getFile(fileDir +"/" + fileName , a);
			FacesContext.getCurrentInstance().responseComplete();
		} catch (IOException e) {
			e.printStackTrace();
		}
	}
}

/**

* ログダウンロード画面

* */

@ManagedBean(name="LogDownload")

@SessionScoped

public class LogDownload implements Serializable {

private static final long serialVersionUID = 1L;

protected static Logger logger = LogManager.getLogger();

@EJB

private SFTPFileAccess ftp;

private String selectedServer;

private List<LogFile> fileList;

public LogDownload() {

fileList = new ArrayList<LogFile>();

}

public List<LogFile> getFileList() {

return fileList;

}

public void setFileList(List<LogFile> fileList) {

this.fileList = fileList;

}

public String getSelectedServer() {

return this.selectedServer;

}

public void setSelectedServer(String selectedServer) {

this.selectedServer = selectedServer;

}

/**

* ディレクトリ選択時にファイル一覧を取得

* */

public void getList(){

try {

Map<String,String> params = FacesContext.getCurrentInstance().getExternalContext().getRequestParameterMap();

String fileDir = params.get("fileDir");

ftp.loginHost(selectedServer, dao.getServerLoginUser(selectedServer), dao.getServerLoginPasswd(selectedServer));

fileList.clear();

ftp.getSFTPList(fileDir,fileList);

} catch (IOException e) {

e.printStackTrace();

}

/**

* ファイルダウンロード

* */

public void getFile(){

Map<String,String> params = FacesContext.getCurrentInstance().getExternalContext().getRequestParameterMap();

String fileName = params.get("fileName");

String fileDir = params.get("fileDir");

try {

HttpServletResponse response = (HttpServletResponse) FacesContext.getCurrentInstance() .getExternalContext().getResponse();

response.setContentType("application/octet-stream");

response.setHeader("Content-Disposition", "attachment;filename=" + fileName);

OutputStream a = response.getOutputStream();

ftp.getFile(fileDir +"/" + fileName , a);

FacesContext.getCurrentInstance().responseComplete();

} catch (IOException e) {

e.printStackTrace();

}

xhtml
※ディレクトリリストの箇所は、上記ソース上割愛しています。
ディレクトリリストの左に置いたボタンクリックで、ファイル一覧を取得し、ファイル一覧のファイル名クリックでダウンロードします。

    <h:form id="listForm">
      <h:dataTable var="dirlist" value="#{LogDownload.directoryList}" rowIndexVar="rowIndex" class="table">
        <h:column>
          <f:facet name="header" >#{words.Label_LogList}</f:facet>
          <h:commandLink value="#{dirlist.INFO_VALUE}" actionListener="#{LogDownload.downLoad}">
            <f:attribute name="directory" value="#{dirlist.INFO_VALUE}"/>
          </h:commandLink>
        </h:column>
        <h:column>
          <h:commandButton id="listget" action="#{LogDownload.getList}" value="#{words.Label_FileListGet}">
            <f:param name="fileDir" value="#{dirlist.INFO_VALUE}" />
            <f:ajax render=":listForm:loglist"/>
          </h:commandButton>
        </h:column>
      </h:dataTable>
    
      <h:dataTable id="loglist" var="list" value="#{LogDownload.fileList}" styleClass="listTable">
        <h:column><f:facet name="header" >ファイル名</f:facet>
        <h:commandLink id="filelistName" value="#{list.fileName}" action="#{LogDownload.getFile}">
        <f:param name="fileName" value="#{list.fileName}" />
        <f:param name="fileDir" value="#{list.directory}" />
        </h:commandLink>
      </h:column>
      <h:column><f:facet name="header">ファイルサイズ</f:facet>
        <h:outputText value="#{list.fileSize}">
          <f:convertNumber groupingUsed="true" />
        </h:outputText>
      </h:column>
      <h:column><f:facet name="header" >ファイル更新日時</f:facet>
        <h:outputText value="#{list.upDateTime}"/>
      </h:column>
    </h:dataTable>    
  </h:form>

<h:form id="listForm">

<h:dataTable var="dirlist" value="#{LogDownload.directoryList}" rowIndexVar="rowIndex" class="table">

<h:column>

<f:facet name="header" >#{words.Label_LogList}</f:facet>

<h:commandLink value="#{dirlist.INFO_VALUE}" actionListener="#{LogDownload.downLoad}">

<f:attribute name="directory" value="#{dirlist.INFO_VALUE}"/>

</h:commandLink>

</h:column>

<h:column>

<h:commandButton id="listget" action="#{LogDownload.getList}" value="#{words.Label_FileListGet}">

<f:param name="fileDir" value="#{dirlist.INFO_VALUE}" />

<f:ajax render=":listForm:loglist"/>

</h:commandButton>

</h:column>

</h:dataTable>

<h:dataTable id="loglist" var="list" value="#{LogDownload.fileList}" styleClass="listTable">

<h:column><f:facet name="header" >ファイル名</f:facet>

<h:commandLink id="filelistName" value="#{list.fileName}" action="#{LogDownload.getFile}">

<f:param name="fileName" value="#{list.fileName}" />

<f:param name="fileDir" value="#{list.directory}" />

</h:commandLink>

</h:column>

<h:column><f:facet name="header">ファイルサイズ</f:facet>

<h:outputText value="#{list.fileSize}">

<f:convertNumber groupingUsed="true" />

</h:outputText>

</h:column>

<h:column><f:facet name="header" >ファイル更新日時</f:facet>

<h:outputText value="#{list.upDateTime}"/>

</h:column>

</h:dataTable>

</h:form>

エラーハンドリングやサーバの切断、ファイルサイズの数値右寄せ等、細かい箇所がまだ出来ていませんが、とりあえず動きそうです。
最初、ログファイル情報のプロパティ名が先頭大文字とかだと、JSFでエラーになりちょっとハマりました。。

レルムの代わりにJASPICで

投稿日時: 2015年11月2日投稿者: bokusui

　今、企業内で少人数が使用するWEBアプリケーションをWebLogicで動かす前提で作ってますが、ユーザー認証についてどうしようかと要件を確認したところ、少人数使用のアプリなのでLDAP無し、WebLogicに登録・管理したくないのでWeblogicのレルムも使わないでとのこと。となると従来のDBにユーザーテーブル作ってユーザー管理画面とかも作る感じになります。
　ユーザーには数パターンあるうちの１つの権限を付与すれば使える画面と使えない画面が決まるので、基本的にURLで制御できる範囲です。で、いろいろ調べましたが、下記を参考にして、JASPIC(Java Authentication Service Provider Interface for Containers)というJavaEE7仕様に含まれているものを使ってみる事にしました。
http://arjan-tijms.omnifaces.org/2012/11/implementing-container-authentication.html
ここのSETP5にあるServerAuthModule実装のvalidateRequestに認証処理を書き込む形のようです。
下記のサンプルソースも参考になりました。
https://github.com/erik-wramner/YubikeyAuth/tree/master/yubi-jaspic-example

但し、WebLogicで動かす場合は、web.xmlにだけ設定すればよいだけでなく、weblogic.xmlにも同じような設定が必要みたいです。

web.xml

  <security-role>
    <description>管理者</description>
    <role-name>Managers</role-name>
  </security-role>
  <security-role>
    <description>利用者</description>
    <role-name>Users</role-name>
  </security-role>
  
  <security-constraint>
    <web-resource-collection>
      <web-resource-name>manager page</web-resource-name>
      <url-pattern>/manage/*</url-pattern>
    </web-resource-collection>
    <auth-constraint>
      <role-name>Managers</role-name>
    </auth-constraint>
  </security-constraint>

  <security-constraint>
    <web-resource-collection>
      <web-resource-name>user page</web-resource-name>
      <url-pattern>/user/*</url-pattern>
    </web-resource-collection>
    <auth-constraint>
      <role-name>Users</role-name>
    </auth-constraint>
  </security-constraint>

<security-role>

<role-name>Managers</role-name>

</security-role>

<security-role>

<role-name>Users</role-name>

</security-role>

<security-constraint>

<web-resource-collection>

<web-resource-name>manager page</web-resource-name>

<url-pattern>/manage/*</url-pattern>

</web-resource-collection>

<auth-constraint>

<role-name>Managers</role-name>

</auth-constraint>

</security-constraint>

<security-constraint>

<web-resource-collection>

<web-resource-name>user page</web-resource-name>

<url-pattern>/user/*</url-pattern>

</web-resource-collection>

<auth-constraint>

<role-name>Users</role-name>

</auth-constraint>

</security-constraint>

weblogic.xml

    <wls:security-role-assignment>
      <wls:role-name>Managers</wls:role-name>
      <wls:principal-name>Managers</wls:principal-name>
    </wls:security-role-assignment>
    
    <wls:security-role-assignment>
      <wls:role-name>Users</wls:role-name>
      <wls:principal-name>Users</wls:principal-name>
    </wls:security-role-assignment>

<wls:security-role-assignment>

<wls:role-name>Managers</wls:role-name>

<wls:principal-name>Managers</wls:principal-name>

</wls:security-role-assignment>

<wls:security-role-assignment>

<wls:role-name>Users</wls:role-name>

<wls:principal-name>Users</wls:principal-name>

</wls:security-role-assignment>

デプロイするとそのインスタンス全体に影響し、開発環境では管理サーバで動かしているので管理コンソールに入れなくなります。。

FilterでWeb要求・応答をログ出力してみる

投稿日時: 2015年9月19日投稿者: bokusui

今、リクエストを受信した後に対外接続を行うシステムを作ってますが、がつがつと外部に繋ぐのも気が引けるという事で、、そのシミュレータとして簡単なWebAPも作りました。
APサーバは、WebLogic11G。作っているAPの仕様上、POSTをサーブレット処理してます。
で、結局Oracleのページに乗っていたグッドなサンプルをそのままパクってみました（汗）
Oracle Containers for J2EE サーブレット開発者ガイド
Request処理は解るのですが、Responseの方はFilter内でラップするというちょっと自分では考え付かない内容でした。。
上記に載っている、FilterServletOutputStreamとGenericResponseWrapperは、深く考えずに同一パッケージ内にそのままクラスとして作ります。
で、Filterクラスを作ってログを出力します。よく使っているlog4j2でやってます。

package jp.esoro.http;

import java.io.BufferedReader;
import java.io.IOException;
import java.io.OutputStream;

import javax.servlet.Filter;
import javax.servlet.FilterChain;
import javax.servlet.FilterConfig;
import javax.servlet.ServletException;
import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;

public class PostFilter implements Filter {
	protected static Logger logger = LogManager.getLogger();
	
	@Override
	public void destroy() {
	}

	@Override
	public void doFilter(ServletRequest request, ServletResponse response,
			FilterChain chain) throws IOException, ServletException {
 		try {
 			//要求
			HttpServletRequest req = (HttpServletRequest) request;
			
			BufferedReader body = new BufferedReader(req.getReader());
			String ret = body.readLine();
			//要求ロギング
			logger.info(req.getRemoteAddr()+"->"+req.getLocalAddr()+":"+req.getLocalPort()+req.getContextPath() + ":" + req.getMethod() + " RCV:"+ret);

			OutputStream out = response.getOutputStream();
			
			GenericResponseWrapper wrapper = 
			         new GenericResponseWrapper((HttpServletResponse) response); 
			//この後、サーブレット側処理に移ります
			chain.doFilter(request, wrapper);	
			
			//ラップしたwrapperからサーブレットの処理結果を取得
			byte[] data = wrapper.getData();
 			//OutputStreamに書き込んで応答
			out.write(data);
			out.close();
			//Shift-JISでString変換
			String result = new String(data, "Shift-JIS");
			//応答ロギング
			logger.info(req.getRemoteAddr()+"<-"+req.getLocalAddr()+ ":"+req.getLocalPort()+ req.getContextPath() + ":" + req.getMethod() + " SND:"+result);

		} catch (IOException e) {
			logger.error(e.getMessage());
		}
	}
	@Override
	public void init(FilterConfig arg0) throws ServletException {
	}
}

package jp.esoro.http;

import java.io.BufferedReader;

import java.io.IOException;

import java.io.OutputStream;

import javax.servlet.Filter;

import javax.servlet.FilterChain;

import javax.servlet.FilterConfig;

import javax.servlet.ServletException;

import javax.servlet.ServletRequest;

import javax.servlet.ServletResponse;

import javax.servlet.http.HttpServletRequest;

import javax.servlet.http.HttpServletResponse;

import org.apache.logging.log4j.LogManager;

import org.apache.logging.log4j.Logger;

public class PostFilter implements Filter {

protected static Logger logger = LogManager.getLogger();

@Override

public void destroy() {

}

@Override

public void doFilter(ServletRequest request, ServletResponse response,

FilterChain chain) throws IOException, ServletException {

try {

//要求

HttpServletRequest req = (HttpServletRequest) request;

BufferedReader body = new BufferedReader(req.getReader());

String ret = body.readLine();

//要求ロギング

logger.info(req.getRemoteAddr()+"->"+req.getLocalAddr()+":"+req.getLocalPort()+req.getContextPath() + ":" + req.getMethod() + " RCV:"+ret);

OutputStream out = response.getOutputStream();

GenericResponseWrapper wrapper =

new GenericResponseWrapper((HttpServletResponse) response);

//この後、サーブレット側処理に移ります

chain.doFilter(request, wrapper);

//ラップしたwrapperからサーブレットの処理結果を取得

byte[] data = wrapper.getData();

//OutputStreamに書き込んで応答

out.write(data);

out.close();

//Shift-JISでString変換

String result = new String(data, "Shift-JIS");

//応答ロギング

logger.info(req.getRemoteAddr()+"<-"+req.getLocalAddr()+ ":"+req.getLocalPort()+ req.getContextPath() + ":" + req.getMethod() + " SND:"+result);

} catch (IOException e) {

logger.error(e.getMessage());

}

@Override

public void init(FilterConfig arg0) throws ServletException {

}

で、web.xmlに上記Filterをセットします

 	<!-- Filter -->
	<filter>
		<filter-name>PostFilter</filter-name>
		<filter-class>jp.esoro.http.PostFilter</filter-class>
	</filter>
	<filter-mapping>
        <filter-name>PostFilter</filter-name>
        <url-pattern>/*</url-pattern>
    </filter-mapping>

<filter-name>PostFilter</filter-name>

<filter-class>jp.esoro.http.PostFilter</filter-class>

</filter>

<filter-mapping>

<filter-name>PostFilter</filter-name>

<url-pattern>/*</url-pattern>

</filter-mapping>

最初サーブレットはアノテーション@WebServletで書きましたが、どうも11Gだとダメっぽいのでweb.xmlにservletをMappingする事にしました。シミュレータは本当に簡単なAPなので。。
開発環境は他のプロジェクトで使うWebLogic12cのままで11Gを別途用意しなかったんですが、実行環境が違うとデプロイに失敗して結構メンドクサイです。コンパイラーJavaのバージョンをちゃんと確認してなかったからなんですけど、、

WLSのデータソース設定せずにJPA

投稿日時: 2015年7月29日投稿者: bokusui

今筆者が作っているWEBアプリケーションのDB周り実装です。
インフラ的には、主にWLS12＋OracleDBとなっていますが、社内特定部署に利用が限定されたアプリケーションなので、DBセッションは「節約したい」という微妙な要件です。さらに、WLSデータソース設定はしたくないとの希望です。
せっかくEE使うんで、JPA前提でやる事にしますが、WEBに出てる殆どのネタがWLSのデータソースを使っているんですよね。
セッションプールは別途OracleUCPの独自実装があるので、persistance.xmlで指定せずに、UCPのデータソースをプログラム上からエンティティマネージャに指定するというイメージなんですが、WEBで調べながら実際に動くまで結構時間掛かりました。。

まず、EclipseのプロジェクトファセットにJPAを追加するとpersistence.xmlが出来ますが、データソースをここでは設定しないのでエンティティクラス定義のみ書きます。

<?xml version="1.0" encoding="UTF-8"?>
<persistence version="2.0" xmlns="http://java.sun.com/xml/ns/persistence" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://java.sun.com/xml/ns/persistence http://java.sun.com/xml/ns/persistence/persistence_2_0.xsd">
	<persistence-unit name="DBresource" transaction-type="RESOURCE_LOCAL">
		<class>jp.xxx.zzz.model.user.LoginUser</class>
他クラス定義省略
   	<exclude-unlisted-classes>true</exclude-unlisted-classes>
	</persistence-unit> 
</persistence>

<?xml version="1.0" encoding="UTF-8"?>

<persistence-unit name="DBresource" transaction-type="RESOURCE_LOCAL">

<class>jp.xxx.zzz.model.user.LoginUser</class>

他クラス定義省略

<exclude-unlisted-classes>true</exclude-unlisted-classes>

</persistence-unit>

</persistence>

次にエンティティクラス（テーブル定義みたいなもの）

@Table(name="USER_MST")
@Entity
public class LoginUser implements Serializable{
	
	private static final long serialVersionUID = 1L;
	
	/** ユーザーＩＤ*/ @Id @NotNull @Size(max=20,min=7) 
	private String USER_ID;
	/** ユーザーパスワード*/
	private String USER_PASS;
	/** ユーザー種別*/ @NotNull
	private String USER_TYPE;
以下、項目とゲッタセッタは省略

@Table(name="USER_MST")

@Entity

public class LoginUser implements Serializable{

private static final long serialVersionUID = 1L;

/** ユーザーＩＤ*/ @Id @NotNull @Size(max=20,min=7)

private String USER_ID;

/** ユーザーパスワード*/

private String USER_PASS;

/** ユーザー種別*/ @NotNull

private String USER_TYPE;

以下、項目とゲッタセッタは省略

その次が、データアクセスインターフェース（データ操作定義）

/**
 * ログインユーザーマスタ 
 * Data access object interface
 * */
public interface LoginUserDao {

    /***
     * データ1件取得
     * @return キー
     * */
    public LoginUser find(Object id);
    
    /***
     * データ新規作成
     * */
	public void create(LoginUser entitiy);

    /**
     * データ更新
     * */
    public void update(LoginUser entitiy);

    /**
     * データ全件取得
     * */
    public List<LoginUser> getAll();
    
    /**
     * データ件数取得
     * */
    public long  getAllCnt();
}

/**

* ログインユーザーマスタ

* Data access object interface

* */

public interface LoginUserDao {

/***

* データ1件取得

* @return キー

* */

public LoginUser find(Object id);

/***

* データ新規作成

* */

public void create(LoginUser entitiy);

/**

* データ更新

* */

public void update(LoginUser entitiy);

/**

* データ全件取得

* */

public List<LoginUser> getAll();

/**

* データ件数取得

* */

public long getAllCnt();

}

さらに上記インターフェースをJPA実装したデータアクセスオブジェクト（DAO)

/**
 * ログインユーザーマスタ
 * Data access object (JPA)
 * */
@Stateless
//@TransactionAttribute(TransactionAttributeType.REQUIRED)
public class LoginUserDaoJpa implements LoginUserDao{
	protected static Logger logger = LogManager.getLogger();
	public EntityManager  em = null;

	/**
	 * コンストラクタ
	 * */
	public LoginUserDaoJpa() {
		super();
		em = DBEntityManager.getEntityManager();
	}
	/**
	 * データ検索
	 * @param id (key)
	 * @return LoginUser
	 * */
	@Override
	public LoginUser find(Object id) {
		return em.find(LoginUser.class, id);
	}
	/**
	 * データ新規登録
	 * @param ServerConf 
	 * */
	@Override
	public void create(LoginUser entity) {
 		EntityTransaction txn = em.getTransaction();
 		txn.begin();

    	if ( ! em.getTransaction().isActive() ){
    		em.getTransaction().begin();
    	}
		em.persist(entity);
        txn.commit();
	}

	/**
	 * ユーザーマスタの全取得
	 * @return ログインユーザーマスタのリスト
	 * */
	@SuppressWarnings("unchecked")
	@Override
	public  List<LoginUser>  getAll() {
		//後日追加
		em.clear();
		List<LoginUser> result = em.createQuery("SELECT c FROM LoginUser c WHERE c.STATUS_FLG < :SFLG ORDER BY c.USER_ID")
					.setParameter("SFLG", "9")
					.getResultList();
    	return result;
    } 	
	/**
	 * ユーザーマスタより業務メンバーの取得
	 * @return ログインユーザーマスタのリスト
	 * */
	@SuppressWarnings("unchecked")
	public  List<LoginUser>  getBizMember() {
		//後日追加
		em.clear();
		List<LoginUser> result = em.createQuery("SELECT c FROM LoginUser c WHERE c.USER_TYPE < '5' AND c.STATUS_FLG < :SFLG ORDER BY c.USER_ID")
					.setParameter("SFLG", "9")
					.getResultList();
    	return result;
    }
    /**
     * データ更新
     * @param ServerConf
     * */
	@Override
 	public void update(LoginUser entity) {
 		EntityTransaction txn = em.getTransaction();
 		txn.begin();

    	if ( ! em.getTransaction().isActive() ){
    		em.getTransaction().begin();
    	}
        em.merge(entity);
        txn.commit();
    }
 	/**
 	 * 件数取得
 	 * */
	public long  getAllCnt() {
    	return em.createQuery("SELECT c FROM UserMaster c").getMaxResults();
    }
}

/**

* ログインユーザーマスタ

* Data access object (JPA)

* */

@Stateless

//@TransactionAttribute(TransactionAttributeType.REQUIRED)

public class LoginUserDaoJpa implements LoginUserDao{

protected static Logger logger = LogManager.getLogger();

public EntityManager em = null;

/**

* コンストラクタ

* */

public LoginUserDaoJpa() {

super();

em = DBEntityManager.getEntityManager();

}

/**

* データ検索

* @param id (key)

* @return LoginUser

* */

@Override

public LoginUser find(Object id) {

return em.find(LoginUser.class, id);

}

/**

* データ新規登録

* @param ServerConf

* */

@Override

public void create(LoginUser entity) {

EntityTransaction txn = em.getTransaction();

txn.begin();

if ( ! em.getTransaction().isActive() ){

em.getTransaction().begin();

}

em.persist(entity);

txn.commit();

}

/**

* ユーザーマスタの全取得

* @return ログインユーザーマスタのリスト

* */

@SuppressWarnings("unchecked")

@Override

public List<LoginUser> getAll() {

//後日追加

em.clear();

List<LoginUser> result = em.createQuery("SELECT c FROM LoginUser c WHERE c.STATUS_FLG < :SFLG ORDER BY c.USER_ID")

.setParameter("SFLG", "9")

.getResultList();

return result;

}

/**

* ユーザーマスタより業務メンバーの取得

* @return ログインユーザーマスタのリスト

* */

@SuppressWarnings("unchecked")

public List<LoginUser> getBizMember() {

//後日追加

em.clear();

List<LoginUser> result = em.createQuery("SELECT c FROM LoginUser c WHERE c.USER_TYPE < '5' AND c.STATUS_FLG < :SFLG ORDER BY c.USER_ID")

.setParameter("SFLG", "9")

.getResultList();

return result;

}

/**

* データ更新

* @param ServerConf

* */

@Override

public void update(LoginUser entity) {

EntityTransaction txn = em.getTransaction();

txn.begin();

if ( ! em.getTransaction().isActive() ){

em.getTransaction().begin();

}

em.merge(entity);

txn.commit();

}

/**

* 件数取得

* */

public long getAllCnt() {

return em.createQuery("SELECT c FROM UserMaster c").getMaxResults();

}

上記DAOのコンストラクタで読んでいるEntityManagerを取得するシングルトンクラス

public class DBEntityManager {
	protected static Logger logger = LogManager.getLogger();
	private static Map<String, Object> configOverrides;
	
	static {
		Map<String, Object> map = new HashMap<String, Object>();		
		try {
			//ここのDBConnectionMgrとは、UCPを使用してデータソースを戻す独自実装です・・
			//独自実装内で各種JDBC設定がされています・・
			map.put("javax.persistence.nonJtaDataSource", DBConnectionMgr.getDataSource());
		} catch (SQLException e) {
			logger.error("DBConnectionPool JpaEntityManager put Error!", e);
		}
		configOverrides = Collections.unmodifiableMap(map);
	}
	/**
	 * EntityManagerを返します
	 * */
	public static EntityManager getEntityManager(){
		return Persistence.createEntityManagerFactory("DBresource", configOverrides).createEntityManager();
	}
}

public class DBEntityManager {

protected static Logger logger = LogManager.getLogger();

private static Map<String, Object> configOverrides;

static {

Map<String, Object> map = new HashMap<String, Object>();

try {

//ここのDBConnectionMgrとは、UCPを使用してデータソースを戻す独自実装です・・

//独自実装内で各種JDBC設定がされています・・

map.put("javax.persistence.nonJtaDataSource", DBConnectionMgr.getDataSource());

} catch (SQLException e) {

logger.error("DBConnectionPool JpaEntityManager put Error!", e);

}

configOverrides = Collections.unmodifiableMap(map);

}

/**

* EntityManagerを返します

* */

public static EntityManager getEntityManager(){

return Persistence.createEntityManagerFactory("DBresource", configOverrides).createEntityManager();

}

上記を呼び出しているJava画面ソース

/**
 * ユーザーマスタ管理画面処理（ユーザー作成・更新・削除・パスワード変更共通）
 * 
 * */
@ManagedBean(name="UserManager")
@ViewScoped
public class UserManager implements Serializable {
	private static final long serialVersionUID = 1L;

    @EJB
    private LoginUserDao dao;
	
	List<LoginUser> List;
	
	@ManagedProperty("#{userDto}")
	LoginUserDto user;

	public LoginUserDto getUser() {
		return user;
	}

	public void setUser(LoginUserDto user) {
		this.user = user;
	}

	/** 以下画面項目 */
	public List<LoginUser> getList() {
    	List = dao.getAll();
		return List;
	}

	public void setList(List<LoginUser> list) {
		List = list;
	}
以下省略

/**

* ユーザーマスタ管理画面処理（ユーザー作成・更新・削除・パスワード変更共通）

* */

@ManagedBean(name="UserManager")

@ViewScoped

public class UserManager implements Serializable {

private static final long serialVersionUID = 1L;

@EJB

private LoginUserDao dao;

List<LoginUser> List;

@ManagedProperty("#{userDto}")

LoginUserDto user;

public LoginUserDto getUser() {

return user;

}

public void setUser(LoginUserDto user) {

this.user = user;

}

/** 以下画面項目 */

public List<LoginUser> getList() {

List = dao.getAll();

return List;

}

public void setList(List<LoginUser> list) {

List = list;

}

以下省略

最後に上記呼び出し箇所のXHMLの抜粋

  <h:dataTable var="item" value="#{UserManager.list}" columnClasses="userid,username" >
    <h:column>
      <f:facet name="header">#{words.Label_UserID}</f:facet>
      <h:outputText value="#{item.USER_ID}" />
    </h:column>
  </h:dataTable>

<h:dataTable var="item" value="#{UserManager.list}" columnClasses="userid,username" >

<h:column>

<f:facet name="header">#{words.Label_UserID}</f:facet>

<h:outputText value="#{item.USER_ID}" />

</h:column>

</h:dataTable>

後で、テストしたところ、DB更新は出来ていてもクエリーでデータを取得すると反映していませんでした。永続化コンテキストからみの事象と思われますが、細かい仕様を調査するのは骨が折れるので、、、クエリー取得前にEntityManagerをclearする事で対処としました。

JAX-RSを使ってみる

投稿日時: 2015年7月14日投稿者: bokusui

今筆者が作っているサブシステムは、複数種類の定期ジョブとWeblogicで動作させる画面アプリと組合せなんですが、定期ジョブの実装方式として、JAX-RSを検討しました。

なんでジョブをJAX-RSで作るのか？という所なんですが、Weblogicデプロイモジュールに含めることでジョブ実行時のメモリ消費をインフラ設計範囲内に収める為（Coherenceキャッシュへのアクセスがある）と、ジョブ変更時のモジュール管理をサブシステムとして統一したいという理由です。

あと、ジョブ起動については既存のジョブ管理ツールに統一したいとの事なので、EJBスケジューリングは使えない前提です。というか、EJBスケジューリングの挙動検証がしきれてないので、お勧めするのを躊躇したという所なんですが。。

当然、そのままだと外部からアクセスできるので、セキュリティ対策としては要求元ＩＰでフィルタする形で対応する事としてます。

簡単な汎用POSTリクエストモジュールを作成した後、JAX-RSとして動作する処理をJavaEEアプリ内に作成します。

Weblogicデフォルトではなぜか動かなかったので、
weblogic.jaxrs.server.portable.servlet.ServletContainerを使わず、
POMにjerseyを追加

<dependency>
  <groupId>com.sun.jersey</groupId>
  <artifactId>jersey-core</artifactId>
  <version>1.19</version>
</dependency>

<groupId>com.sun.jersey</groupId>

<artifactId>jersey-core</artifactId>

</dependency>

web.xmlを上記に合わせる

  <servlet>
    <description>JAX-RS Tools Generated - Do not modify</description>
    <servlet-name>JAX-RS Servlet</servlet-name>
      <servlet-class>com.sun.jersey.spi.container.servlet.ServletContainer</servlet-class> 
    <load-on-startup>1</load-on-startup>
  </servlet>
  <servlet-mapping>
    <servlet-name>JAX-RS Servlet</servlet-name>
    <url-pattern>/batch/*</url-pattern>
  </servlet-mapping>

<description>JAX-RS Tools Generated - Do not modify</description>

<servlet-name>JAX-RS Servlet</servlet-name>

<servlet-class>com.sun.jersey.spi.container.servlet.ServletContainer</servlet-class>

<load-on-startup>1</load-on-startup>

</servlet>

<servlet-mapping>

<servlet-name>JAX-RS Servlet</servlet-name>

<url-pattern>/batch/*</url-pattern>

</servlet-mapping>

JAX-RSソース（コンテキストルート/batch/JOB1のURLでPOST実行）

/**
 * バッチ処理
 * */
@Path("/JOB1")
public class BatchExecute{
    public String hello(@Context HttpServletRequest request) throws InterruptedException {
        return "Batch GET Hello!";
    }
    /**
     * ジョブ実行
     * */
    @POST
    public Response execute(@Context HttpServletRequest request) {
       //POSTパラメータ取得
       String Interval = request.getParameter("PARAM1");
      ・・・以下省略
    }
}

/**

* バッチ処理

* */

@Path("/JOB1")

public class BatchExecute{

public String hello(@Context HttpServletRequest request) throws InterruptedException {

return "Batch GET Hello!";

}

/**

* ジョブ実行

* */

@POST

public Response execute(@Context HttpServletRequest request) {

//POSTパラメータ取得

String Interval = request.getParameter("PARAM1");

・・・以下省略

}

ジョブ管理の側はログファイルの検知をトリガーにするので、どのプロセスがログに書いたかはどうでもよく、これで行こうと思います

追伸１年経って下記のような事もありました。。
weblogic.xmlのprefer-web-inf-classesをtrueにしたらハマった・・

ESORO system design

「Java」カテゴリーアーカイブ

画面エラーのログ出力を整理

要件はちゃんと確認しないと・・・VFSで作り直し

bootstrapのdatepickerを使ってみる

画面メニューにbootstrapのnavbarを使ってみる

JSF2カスタムコンバータでデコードしつつdataTableの背景を変える

ganymed ssh2を使ってダウンロード画面を作る

レルムの代わりにJASPICで

FilterでWeb要求・応答をログ出力してみる

WLSのデータソース設定せずにJPA

JAX-RSを使ってみる

2025年4月
日	月	火	水	木	金	土
		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