Alfresco勉強会#33 alfresco 5.1でコンテンツ自動削除を実装してみた

1. 第33回Alfresco勉強会
Alfresco 5.1でコンテンツ自動削除を実装してみた
（& Alfresco SDK を使った話も少々）
2016/05/25
@_tasky

2. 自己紹介
 私は…
◦ @_tasky
 日頃は…
◦ 株式会社イージフでAlfrescoやLiferayをいじってます
◦ 2児(5歳♀, 2歳♀)の父親業やってます
◦ Ingressエージェント業も少々

3. Contents
 有効期限の過ぎたコンテンツのアーカイブ
 コンテンツ自動削除機能の概要
 コンテンツ自動削除機能の実装
◦ Alfresco SDK
◦ スケジュールジョブ
 デモ

4. 有効期限の切れたコンテンツのアーカイブ
 よくある要件
◦ コンテンツの属性に有効期限を持たせる
◦ 有効期限を過ぎたコンテンツを自動的にアーカイブ（or削除）す
る
 Effectivity（有効性）アスペクトの利用
◦ Effective From（有効期限開始日）属性
◦ Effective To（有効期限終了日）属性
 が、Effectivityアスペクトを付けたところで、有効期限終了日
を考慮して何がしかの処理を行う機能は実装されていない
⇒ これを実装します

5. コンテンツ自動削除機能の概要
 コンテンツの属性に有効期限を持たせる
◦ 前述のEffectivity（有効性）アスペクトを使い、コンテンツに
Effective From（有効期限開始日）とEffective To（有効期限終了
日）を設定する
⇒ Alfrescoのルール機能を使うと自動的にEffectivityアスペクトを
付与することができる
 有効期限を過ぎたコンテンツを自動的に削除する
◦ 日次バッチ等を想定し、スケジュールジョブとして実装する
◦ “Effectivityアスペクトを持つ && Effective Toの値 < 今日”なコンテ
ンツを削除する
⇒ Alfrescoの一般的なScheduled Jobと同じ形で実装する

6. コンテンツ自動削除機能の実装
 Alfresco SDK（昔のMaven Alfresco SDK）を使って開発
◦ Alfresco Repository (Platform)のみのカスタマイズ
 プロジェクトの作成方法は以下の記事を参照
http://www.slideshare.net/terajun/alfresco26-alfresco-sdk
 主要なポイントは以下のとおり
◦ アーキタイプ : org.alfresco.maven.archetype:alfresco-amp-
archetype 2.2.0 (Alfresco Repository AMPアーキタイプ)
◦ 生成されたpom.xmlの修正
<alfresco.version>5.1.f</alfresco.version>
◦ EclipseのMaven build Configuration
 Goals : install
 Profiles : amp-to-war
 JRE : JavaSE-1.8
 VM arguments : -Xms1G -Xmx2G -noverify

7. コンテンツ自動削除機能の実装
 config/alfresco/module/content-archive-
sample/content/service-context.xml
◦ Spring bean定義ファイル
◦ ジョブ実装、ジョブ実体、トリガを定義
 config/alfresco/module/content-archive-sample/alfresco-
global.properties
◦ bean定義が参照するジョブ実行タイミング等を設定
 IneffectiveContentArchiver.java
◦ ジョブ処理内容の実装クラス
 IneffectiveContentArchiveJob.java
◦ ジョブ実体を表すクラス
◦ bean定義で指定された処理を実行する

8. service-context.xml
 ineffectiveContentArchiver : ジョブ処理内容の実装定義
 ineffectiveContentArchiverJobDetail : ジョブ実体定義
 ineffectiveContentArchiverTrigger : ジョブのスケジュール実
行定義
<bean id="ineffectiveContentArchiver" class="jp.aegif.alfresco.repo.content.archive.IneffectiveContentArchiver">
<property name="searchService" ref="searchService" />
<property name="nodeService" ref="nodeService" />
<property name="transactionService" ref="transactionService" />
</bean>
<bean id="ineffectiveContentArchiverJobDetail" class="org.springframework.scheduling.quartz.JobDetailBean">
<property name="jobClass" value="jp.aegif.alfresco.repo.content.archive.IneffectiveContentArchiveJob" />
<property name="jobDataAsMap">
<map>
<entry key="ineffectiveContentArchiver">
<ref bean="ineffectiveContentArchiver" />
</entry>
<entry key="jobLockService">
<ref bean="jobLockService" />
</entry>
</map>
</property>
</bean>
<bean id="ineffectiveContentArchiverTrigger" class="org.alfresco.util.CronTriggerBean">
<property name="jobDetail" ref="ineffectiveContentArchiverJobDetail" />
<property name="scheduler" ref="schedulerFactory" />
<property name="cronExpression" value="${ineffective.content.archive.cronExpression}" />
<property name="startDelay" value="${ineffective.content.archive.cronStartDelay}" />
</bean>

9. alfresco-global.properties
 ジョブ実行タイミング等を設定
 bean定義から参照される
 ineffective.content.archive.cronExpression :
◦ ジョブ実行タイミングのcron表記
◦ Quartzのcronフォーマットに従うので ”秒 分 時 日 月 曜日”
 ineffective.content.archive.cronStartDelay :
◦ サーバ起動時の実行遅延（ミリ秒）
ineffective.content.archive.cronExpression=0 * * * * ?
ineffective.content.archive.cronStartDelay=60000

10. IneffectiveContentArchiver.java
 Effectivityアスペクトを持ち、かつEffectivity To (cm:to)属性が
今日より古いコンテンツを検索する
 ヒットしたコンテンツを削除する
◦ 正確には、ゴミ箱に入ります
public void execute() {
transactionService.getRetryingTransactionHelper().doInTransaction(
new RetryingTransactionCallback<Object>() {
@Override
public Object execute() throws Throwable {
String query = "+ASPECT:"cm:effectivity" +@cm:to:[MIN TO NOW]";
ResultSet rs = null;
SearchParameters sp = new SearchParameters();
sp.setLanguage(SearchService.LANGUAGE_LUCENE);
sp.addStore(StoreRef.STORE_REF_WORKSPACE_SPACESSTORE);
sp.setQuery(query);
rs = searchService.query(sp);
for (NodeRef nodeRef : rs.getNodeRefs()) {
nodeService.deleteNode(nodeRef);
}
logger.debug("Archive " + rs.length() + " nodes");
return null;
}
});
}

11. IneffectiveContentArchiveJob.java
 AbstractScheduledLockedJobを継承するとcluster awareな
Jobになる
 bean定義のjobDataAsMapで指定されたジョブ実装を読み込
んで実行する
public class IneffectiveContentArchiveJob extends AbstractScheduledLockedJob implements StatefulJob {
@Override
public void executeJob(JobExecutionContext context) throws JobExecutionException {
JobDataMap jobDataMap = context.getJobDetail().getJobDataMap();
Object ineffectiveContentArchiverObject = jobDataMap.get("ineffectiveContentArchiver");
if (ineffectiveContentArchiverObject == null || !(ineffectiveContentArchiverObject instanceof
IneffectiveContentArchiver)) {
throw new AlfrescoRuntimeException("Invalid JobData for IneffectiveContentArchiveJob");
}
final IneffectiveContentArchiver ineffectiveContentArchiver =
(IneffectiveContentArchiver)ineffectiveContentArchiverObject;
AuthenticationUtil.runAsSystem(new RunAsWork<Object>() {
@Override
public Object doWork() throws Exception {
ineffectiveContentArchiver.execute();
return null;
}
});
}
}

12. テスト用Alfresco Shareの準備
 Alfresco Repository AMPアーキタイプを使うと、テスト用
Tomcatの起動ができる
 ただし、Alfresco Repository (Platform)しか起動しないので、別
途Alfresco Shareを起動する必要がある
⇒ Alfresco Share AMPアーキタイプを使ってMaven Projectを作
成し、テスト用Alfresco Shareを起動する
 主要なポイントは以下のとおり
◦ アーキタイプ : org.alfresco.maven.archetype:share-amp-archetype
2.2.0
◦ 生成されたpom.xmlの修正
 <alfresco.version>5.1.f</alfresco.version>
 spring-surf-api dependencyの記述変更
◦ EclipseのMaven build Configuration
 Goals : install
 Profiles : amp-to-war
 Parameter : dependency.surf.version=6.3
 JRE : JavaSE-1.8
<dependency>
<groupId>org.alfresco.surf</groupId>
<artifactId>spring-surf-api</artifactId>
<version>${dependency.surf.version}</version>
<scope>provided</scope>
</dependency>

13. デモ
 環境
◦ Windows 10
◦ Alfresco Community Edition 5.1.f
◦ Alfresco SDK 2.2.0
 URL
◦ Alfresco Repository : http://localhost:8080/alfresco/
◦ Alfresco Share : http://localhost:8081/share/
 サンプルコード
https://bitbucket.org/tasuku_otani/content-archive-sample

14. まとめ
 有効期間を過ぎたコンテンツを自動削除するスケジュール
ジョブを作った
 課題
◦ 有効期限終了日当日のコンテンツも削除しちゃってる
◦ 削除じゃなくてアーカイブしたい

15. おまけ
 aegif Labo blog やってます
http://aegif-labo.blogspot.jp/
 2016/05/17にAlfresco Community Edition 5.1.gがリリースさ
れました
◦ 5.1.fとの差分はImageMagick脆弱性(ImageTragick)対応のみ
https://wiki.alfresco.com/wiki/Community_file_list_201605-GA