Confluence 6.10 への準備
このドキュメントでは、既存のプラグインおよびアドオンに Confluence 6.10 との互換性があるかどうかを確認したい、Confluence 開発者向けの情報をご案内します。
Confluence 6.10 の開発中は毎週マイルストーンをリリースする予定です。このページで、新しいマイルストーンの公開タイミング、および変更内容をご確認ください。ベータ版のリリース後、正式なリリース ノートを公開します。
最新のマイルストーン
6 月 20 日 | 6.10.0-rc1 | ダウンロード |
このマイルストーンで問題が見受けられた場合
Confluence EAP のヘッダーで [フィードバック] ボタンをクリックするか、課題を起票してお知らせください。
Confluence 6.10 での変更
リリース候補 1 - 2018 年 6 月 20 日
Confluence 6.10 のリリースの準備中です。このリリース候補には大きな変更はありません。
読み取り専用モードで小規模な変更を 1 つ行い、ErrorHandler
が、フロントエンド コードがエラー応答を正しく処理するために使用する MessageController
になりました。
ベータ 1 - 2018 年 6 月 13 日
このベータ版では次のような変更が行われています。
- Apache Tomcat をバージョン 8 から 9 にアップグレードしました。
- ドキュメント変換のための新しいメソッドを追加しました (Data Center のみ)
このリリースの機能の完全な詳細については、Confluence 6.10.0 ベータ リリース ノートを参照してください。
マイルストーン 61 - 2018 年 6 月 4 日
サポート対象プラットフォームの変更
Microsoft SQL Server 2016 のサポートを開始しました。
また、Apache Tomcat をバージョン 9 にアップグレードする予定です。これは次回のマイルストーンで利用可能になる予定です。
読み取り専用モードには Data Center ライセンスが必要
読み取り専用モードの機能は Confluence Data Center 専用に開発されています。
これまでは、読み取り専用モードをテストするには、ダーク機能を有効にする必要がありました。ダーク機能は削除され、サイトに Data Center ライセンスがある場合は管理コンソールにメンテナンス画面が表示されます。
Data Center でアドオンをテストする方法については、「1 台のマシンで Confluence クラスタを開始する」を参照してください。このページには、テストに使用できる 72 時間の Data Center ライセンスもあります。
読み取り専用モードの下位互換性
読み取り専用モードについてのフィードバックをありがとうございます。アドオンが Confluence の以前のバージョンとの後方互換性を損なわずに読み取り専用モードの互換性を簡単に実現できるよう、互換性ライブラリを用意しました。アトラシアンでは現在、ライブラリをオープンソースにしようとしています。最新情報をお待ちください。
アドオンで互換性ライブラリを使用するには、次の手順を実行します。
compile
スコープの新しい依存関係を、次のようにプラグインのpom.xml
ファイルに追加します。<dependency> <groupId>com.atlassian.confluence.compat</groupId> <artifactId>confluence-compat-lib</artifactId> <version>1.2.1</version> </dependency>
amps
を使用してプラグインをビルドしている場合は、次の OSGi パッケージをインポートします。<Import-Package> ... com.atlassian.confluence.api.service.accessmode;resolution:="optional", ... *;resolution:=optional </Import-Package>
注: これは
resolution:="optional"
を使用してオプションのパッケージとしてインポートする必要があります。これを行わない場合、古い Confluence バージョンで機能しません。
ライブラリでは、アドオンを読み取り専用モードで動作させる次のクラス / サービスが提供されています。
- ReadWriteAccessModeCondition
- ReadWriteAccessModeUrlReadingCondition
- AccessModeCompatService
- @ReadOnlyAccessAllowed アノテーション
- @ReadOnlyAccessBlocked アノテーション
web-item または web-panel 記述子で ReadWriteAccessModeCondition
を使用
この ReadWriteAccessModeCondition
は、アクセス モードが READ_WRITE の場合 (Confluence が読み取り専用ではない場合)、web-item または web-panel 定義を表示するために使用できます。例:
<web-item key="awesomeWebItem" name="AwesomeWebItem" section="system.content.button" weight="150">
<label key="i18n.label.key"/>
<tooltip key="i18n.tooltip.key"/>
<condition class="com.atlassian.confluence.plugin.descriptor.web.conditions.ReadWriteAccessModeCondition"/>
<condition class="com.atlassian.confluence.plugin.descriptor.web.conditions.PagePermissionCondition">
<param name="permission">view</param>
</condition>
<styleClass>customCssStyle</styleClass>
<param name="iconClass">customIconClass</param>
</web-item>
上の例では、awesomeWebItem
が表示されるのは、ユーザーがページの閲覧権限を持ち、Confluence が読み取り専用モードではない場合のみです。
web-resource 記述子で ReadWriteAccessModeUrlReadingCondition
を使用
この ReadWriteAccessModeUrlReadingCondition
は、アクセス モードが READ_WRITE
の場合 (Confluence が読み取り専用ではない場合)、web-resource 定義をダウンロードできるようにするために使用できます。例:
<web-resource key="awesome-resources" name="Awesome Resources">
<condition class="com.atlassian.confluence.plugin.descriptor.web.urlreadingconditions.ReadWriteAccessModeUrlReadingCondition">
</condition>
<resource name="awesome-view.js" type="download" location="awesome-view.js"/>
</web-resource>
上の例では、awesome-resources
が表示されるのは、Confluence が読み取り専用モードではない場合のみです。
AccessModeCompatService
の使用
アドオンのロジックでアクセス モードを確認する必要がある場合は、Spring ビーンを宣言し、次のように AccessModeCompatService
をクラス (可能であれば Service コンポーネント、XWork アクション、または REST リソース) に挿入できます。
<beans:bean id="accessModeCompatService" class="com.atlassian.confluence.compat.api.service.accessmode.impl.DefaultAccessModeCompatService"/>
もう 1 つのオプションは、Atlassian Spring Scanner ライブラリを使用してコンパイル時にこのクラスを調べ、@ClasspathComponent
アノテーションでそれを呼び出し元のサービスに挿入する方法です。
@Component
public class AwesomeContentService {
final AccessModeCompatService accessModeCompatService;
@Autowired
public AwesomeContentService(final AccessModeCompatService accessModeCompatService) {
// your awesome business logic
}
}
@ReadOnlyAccessAllowed
注釈の使用
@ReadOnlyAccessAllowed
アノテーションは、リクエストが XWork アクションまたは REST リソースによって提供される場合に読み取り専用チェックをバイパスするためのものです。このアノテーションは、メソッド、クラス、またはパッケージに追加できます。
たとえば、sysadmin が実行するアクションは、読み取り専用モードで次のようにバイパスする必要があります。
@ReadOnlyAccessAllowed
@WebSudoRequired
public class ReIndexAwesomeContentAction extends ConfluenceActionSupport {
@Override
public String execute () throws Exception {
return SUCCESS;
}
}
警告: このアノテーションは、管理操作や、最近閲覧したファイルおよび分析などのユーザーの使用状況の追跡サービスでのみ使用するようにします。
@ReadOnlyAccessBlocked
注釈の使用
通常、POST / PUT / DELETE リクエストを提供するアクションは、読み取り専用モードでは既定でブロックされます。ただし、アクションに次のように @ReadOnlyAccessBlocked
アノテーションが追加されている場合、GET リクエストの提供中にブロックされる場合があります。
@ReadOnlyAccessBlocked
public class ViewAwesomeContentAction extends ConfluenceActionSupport {
@Override
public String execute () throws Exception {
return SUCCESS;
}
}
マイルストーン 52 - 2018 年 5 月 29 日
このマイルストーンには大きな変更はありません。
マイルストーン 44 - 2018 年 5 月 22 日
このマイルストーンには大きな変更はありません。
マイルストーン 32 - 2018 年 5 月 15 日
これは Confluence 6.10 用の最初の公開マイルストーンです。
読み取り専用モードの提供予定
前述のように現在、Data Center のお客様による日常的なメンテナンスの実行、予期しない問題からの回復、または新しいサイトへのコンテンツの移行準備をサポートする、新しい機能に取り組んでいます。
管理者は、エンド ユーザーが実行できる操作を制限するために、サイトを一時的に "読み取り専用モード" にすることができます。ユーザーはページとその履歴を表示することはできますが、コンテンツの作成、編集、コメント、コピー、移動はできません。サイト構成の変更などの管理アクションは制限されません。
エンド ユーザーが実行できる操作を制限するには、サイトが読み取り専用モードとなっている間、アドオン経由でのコンテンツの作成および更新も制限する必要があります。
開発者向けドキュメントの「アドオンに読み取り専用モードとの互換性を持たせる」に移動し、必要な内容をご確認ください。
エディタの TinyMCE のアップグレード予定
前述のように、現在、Confluence エディタを TinyMCE バージョン 3 からバージョン 4 にアップグレードすることに取り組んでいます。
このアップグレードを Confluence 6.10 に導入することは予定されていませんが、この時点でアドオンのテストを開始することをおすすめします。開発者向けドキュメントの「アップグレードした TinyMCE 4 エディタでアプリをテストする方法」に移動し、必要な内容をご確認ください。
最新のドキュメントをお探しの場合は、Confluence EAP スペースで最新のドキュメントをご確認ください。
Did you know we’ve got a new developer community? Head to community.developer.atlassian.com/ to check it out! We’ll be posting in the announcements category if when new EAP releases are available.
このドキュメントでは、既存のプラグインおよびアドオンに Confluence 6.10 との互換性があるかどうかを確認したい、Confluence 開発者向けの情報をご案内します。
Confluence 6.10 の開発中は毎週マイルストーンをリリースする予定です。このページで、新しいマイルストーンの公開タイミング、および変更内容をご確認ください。ベータ版のリリース後、正式なリリース ノートを公開します。
最新のマイルストーン
6 月 20 日 | 6.10.0-rc1 | ダウンロード |
このマイルストーンで問題が見受けられた場合
Confluence EAP のヘッダーで [フィードバック] ボタンをクリックするか、課題を起票してお知らせください。
Confluence 6.10 での変更
リリース候補 1 - 2018 年 6 月 20 日
Confluence 6.10 のリリースの準備中です。このリリース候補には大きな変更はありません。
読み取り専用モードで小規模な変更を 1 つ行い、ErrorHandler を MessageController にしました。
フロントエンド コードがエラー応答プロパティを処理することを確認
ベータ 1 - 2018 年 6 月 13 日
このベータ版では次のような変更が行われています。
- Apache Tomcat をバージョン 8 から 9 にアップグレードしました。
- ドキュメント変換のための新しいメソッドを追加しました (Data Center のみ)
このリリースの機能の完全な詳細については、Confluence 6.10.0 ベータ リリース ノートを参照してください。
マイルストーン 61 - 2018 年 6 月 4 日
サポート対象プラットフォームの変更
Microsoft SQL Server 2016 のサポートを開始しました。
また、Apache Tomcat をバージョン 9 にアップグレードする予定です。これは次回のマイルストーンで利用可能になる予定です。
読み取り専用モードには Data Center ライセンスが必要
読み取り専用モードの機能は Confluence Data Center 専用に開発されています。
これまでは、読み取り専用モードをテストするには、ダーク機能を有効にする必要がありました。ダーク機能は削除され、サイトに Data Center ライセンスがある場合は管理コンソールにメンテナンス画面が表示されます。
Data Center でアドオンをテストする方法については、「1 台のマシンで Confluence クラスタを開始する」を参照してください。このページには、テストに使用できる 72 時間の Data Center ライセンスもあります。
読み取り専用モードの下位互換性
読み取り専用モードについてのフィードバックをありがとうございます。アドオンが Confluence の以前のバージョンとの後方互換性を損なわずに読み取り専用モードの互換性を簡単に実現できるよう、互換性ライブラリを用意しました。アトラシアンでは現在、ライブラリをオープンソースにしようとしています。最新情報をお待ちください。
アドオンで互換性ライブラリを使用するには、次の手順を実行します。
compile
スコープの新しい依存関係を、次のようにプラグインのpom.xml
ファイルに追加します。<dependency> <groupId>com.atlassian.confluence.compat</groupId> <artifactId>confluence-compat-lib</artifactId> <version>1.2.1</version> </dependency>
amps
を使用してプラグインをビルドしている場合は、次の OSGi パッケージをインポートします。<Import-Package> ... com.atlassian.confluence.api.service.accessmode;resolution:="optional", ... *;resolution:=optional </Import-Package>
注: これは
resolution:="optional"
を使用してオプションのパッケージとしてインポートする必要があります。これを行わない場合、古い Confluence バージョンで機能しません。
ライブラリでは、アドオンを読み取り専用モードで動作させる次のクラス / サービスが提供されています。
- ReadWriteAccessModeCondition
- ReadWriteAccessModeUrlReadingCondition
- AccessModeCompatService
- @ReadOnlyAccessAllowed アノテーション
- @ReadOnlyAccessBlocked アノテーション
web-item または web-panel 記述子で ReadWriteAccessModeCondition
を使用
この ReadWriteAccessModeCondition
は、アクセス モードが READ_WRITE の場合 (Confluence が読み取り専用ではない場合)、web-item または web-panel 定義を表示するために使用できます。例:
<web-item key="awesomeWebItem" name="AwesomeWebItem" section="system.content.button" weight="150">
<label key="i18n.label.key"/>
<tooltip key="i18n.tooltip.key"/>
<condition class="com.atlassian.confluence.plugin.descriptor.web.conditions.ReadWriteAccessModeCondition"/>
<condition class="com.atlassian.confluence.plugin.descriptor.web.conditions.PagePermissionCondition">
<param name="permission">view</param>
</condition>
<styleClass>customCssStyle</styleClass>
<param name="iconClass">customIconClass</param>
</web-item>
上の例では、awesomeWebItem
が表示されるのは、ユーザーがページの閲覧権限を持ち、Confluence が読み取り専用モードではない場合のみです。
web-resource 記述子で ReadWriteAccessModeUrlReadingCondition
を使用
この ReadWriteAccessModeUrlReadingCondition
は、アクセス モードが READ_WRITE
の場合 (Confluence が読み取り専用ではない場合)、web-resource 定義をダウンロードできるようにするために使用できます。例:
<web-resource key="awesome-resources" name="Awesome Resources">
<condition class="com.atlassian.confluence.plugin.descriptor.web.urlreadingconditions.ReadWriteAccessModeUrlReadingCondition">
</condition>
<resource name="awesome-view.js" type="download" location="awesome-view.js"/>
</web-resource>
上の例では、awesome-resources
が表示されるのは、Confluence が読み取り専用モードではない場合のみです。
AccessModeCompatService
の使用
アドオンのロジックでアクセス モードを確認する必要がある場合は、Spring ビーンを宣言し、次のように AccessModeCompatService
をクラス (可能であれば Service コンポーネント、XWork アクション、または REST リソース) に挿入できます。
<beans:bean id="accessModeCompatService" class="com.atlassian.confluence.compat.api.service.accessmode.impl.DefaultAccessModeCompatService"/>
もう 1 つのオプションは、Atlassian Spring Scanner ライブラリを使用してコンパイル時にこのクラスを調べ、@ClasspathComponent
アノテーションでそれを呼び出し元のサービスに挿入する方法です。
@Component
public class AwesomeContentService {
final AccessModeCompatService accessModeCompatService;
@Autowired
public AwesomeContentService(final AccessModeCompatService accessModeCompatService) {
// your awesome business logic
}
}
@ReadOnlyAccessAllowed
注釈の使用
@ReadOnlyAccessAllowed
アノテーションは、リクエストが XWork アクションまたは REST リソースによって提供される場合に読み取り専用チェックをバイパスするためのものです。このアノテーションは、メソッド、クラス、またはパッケージに追加できます。
たとえば、sysadmin が実行するアクションは、読み取り専用モードで次のようにバイパスする必要があります。
@ReadOnlyAccessAllowed
@WebSudoRequired
public class ReIndexAwesomeContentAction extends ConfluenceActionSupport {
@Override
public String execute () throws Exception {
return SUCCESS;
}
}
警告: このアノテーションは、管理操作や、最近閲覧したファイルおよび分析などのユーザーの使用状況の追跡サービスでのみ使用するようにします。
@ReadOnlyAccessBlocked
注釈の使用
通常、POST / PUT / DELETE リクエストを提供するアクションは、読み取り専用モードでは既定でブロックされます。ただし、アクションに次のように @ReadOnlyAccessBlocked
アノテーションが追加されている場合、GET リクエストの提供中にブロックされる場合があります。
@ReadOnlyAccessBlocked
public class ViewAwesomeContentAction extends ConfluenceActionSupport {
@Override
public String execute () throws Exception {
return SUCCESS;
}
}
マイルストーン 52 - 2018 年 5 月 29 日
このマイルストーンには大きな変更はありません。
マイルストーン 44 - 2018 年 5 月 22 日
このマイルストーンには大きな変更はありません。
マイルストーン 32 - 2018 年 5 月 15 日
これは Confluence 6.10 用の最初の公開マイルストーンです。
読み取り専用モードの提供予定
前述のように現在、Data Center のお客様による日常的なメンテナンスの実行、予期しない問題からの回復、または新しいサイトへのコンテンツの移行準備をサポートする、新しい機能に取り組んでいます。
管理者は、エンド ユーザーが実行できる操作を制限するために、サイトを一時的に "読み取り専用モード" にすることができます。ユーザーはページとその履歴を表示することはできますが、コンテンツの作成、編集、コメント、コピー、移動はできません。サイト構成の変更などの管理アクションは制限されません。
エンド ユーザーが実行できる操作を制限するには、サイトが読み取り専用モードとなっている間、アドオン経由でのコンテンツの作成および更新も制限する必要があります。
開発者向けドキュメントの「アドオンに読み取り専用モードとの互換性を持たせる」に移動し、必要な内容をご確認ください。
エディタの TinyMCE のアップグレード予定
前述のように、現在、Confluence エディタを TinyMCE バージョン 3 からバージョン 4 にアップグレードすることに取り組んでいます。
このアップグレードを Confluence 6.10 に導入することは予定されていませんが、この時点でアドオンのテストを開始することをおすすめします。開発者向けドキュメントの「アップグレードした TinyMCE 4 エディターでアプリをテストする方法」に移動し、必要な内容をご確認ください。
最新のドキュメントをお探しの場合は、Confluence EAP スペースで最新のドキュメントをご確認ください。
Did you know we’ve got a new developer community? Head to community.developer.atlassian.com/ to check it out! We’ll be posting in the announcements category if when new EAP releases are available.