jp.co.intra_mart.foundation.salesforce.streaming

クラス SalesforceStreamingClientManager

java.lang.Object

jp.co.intra_mart.foundation.salesforce.streaming.SalesforceStreamingClientManager

public class SalesforceStreamingClientManager
extends Object

Salesforce Streaming Client を管理するマネージャです。
Salesforce Streaming セッション、および、トピックの登録、更新、削除、取得を行います。

導入されたバージョン:

8.0.0

バージョン:

8.0.3

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
SalesforceStreamingClientManager()

メソッドのサマリー

修飾子とタイプ	メソッドと説明
void	activateTopic(Topic topic) トピックを有効化します。
void	ariseErrorForcibly() 非推奨です。 試験用です。運用環境では使用しないでください。
void	clearFinishedSessions() SessionInfo.State.FINISHED 状態の Salesforce Streaming セッションをクリアします。
void	deactivateTopic(Topic topic) トピックを無効化します。
protected jp.co.intra_mart.system.salesforce.streaming.repository.SalesforceTopicRepository	getRepository() SalesforceTopicRepository を取得します。
protected jp.co.intra_mart.system.salesforce.streaming.service.SalesforceStreamingClientService	getService() SalesforceStreamingClientService を取得します。
List<SessionInfo>	getSessions() Salesforce Streaming セッション情報を取得します。
List<Topic>	getTopics(TopicSearchCondition condition, int limit, int offset) トピック情報を取得します。
int	getTopicsCount(TopicSearchCondition condition, int limit, int offset) トピック数を取得します。
void	rebootSalesforceStreamingClientService() Salesforce Streaming Client Service を再起動します。
int	registerTopic(Topic topic) トピックを登録します。
void	restartAllSessions() 全ての Salesforce Streaming セッションをリスタートします。
void	restartSession(String sessionId) 指定された Salesforce Streaming セッションをリスタートします。
void	stopSession(String sessionId) 指定された Salesforce Streaming セッションを停止します。
int	unregisterTopic(Topic topic) トピックを削除します。
int	updateTopic(Topic topic) トピックを更新します

クラスから継承されたメソッド java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

コンストラクタの詳細

SalesforceStreamingClientManager

public SalesforceStreamingClientManager()

メソッドの詳細

activateTopic

public void activateTopic(Topic topic)
                   throws SalesforceStreamingClientException

トピックを有効化します。

パラメータ:

topic - トピック

例外:

SalesforceStreamingClientException - トピックの有効化に失敗した場合に発生します。

ariseErrorForcibly

@Deprecated
public void ariseErrorForcibly()

非推奨です。 試験用です。運用環境では使用しないでください。

強制的に通信エラーを発生させます。

clearFinishedSessions

public void clearFinishedSessions()
                           throws SalesforceStreamingClientException

SessionInfo.State.FINISHED 状態の Salesforce Streaming セッションをクリアします。

例外:

SalesforceStreamingClientException - セッションのクリアに失敗した場合に発生します。

deactivateTopic

public void deactivateTopic(Topic topic)
                     throws SalesforceStreamingClientException

トピックを無効化します。

パラメータ:

topic - トピック

例外:

SalesforceStreamingClientException - トピックの無効化に失敗した場合に発生します。

getSessions

public List<SessionInfo> getSessions()
                              throws SalesforceStreamingClientException

Salesforce Streaming セッション情報を取得します。
ログインユーザが属するテナントのセッションのみ取得します。

戻り値:

セッション情報を格納したList

例外:

SalesforceStreamingClientException - セッション情報の取得に失敗した場合に発生します。

getTopics

public List<Topic> getTopics(TopicSearchCondition condition,
                             int limit,
                             int offset)
                      throws SalesforceStreamingClientException

トピック情報を取得します。
ログインユーザが属するテナントのトピックのみ取得します。

パラメータ:

condition - トピック情報取得時の検索条件

limit - 取得件数

offset - 取得を開始する位置

戻り値:

トピック情報を格納したList

例外:

SalesforceStreamingClientException - トピック情報の取得に失敗した場合に発生します。

getTopicsCount

public int getTopicsCount(TopicSearchCondition condition,
                          int limit,
                          int offset)
                   throws SalesforceStreamingClientException

トピック数を取得します。
ログインユーザが属するテナントのトピックのみ取得します。

パラメータ:

condition - トピック数取得時の検索条件

limit - 取得件数

offset - 取得を開始する位置

戻り値:

トピック数

例外:

SalesforceStreamingClientException - トピック数の取得に失敗した場合に発生します。

rebootSalesforceStreamingClientService

public void rebootSalesforceStreamingClientService()
                                            throws SalesforceStreamingClientException

Salesforce Streaming Client Service を再起動します。
一般ユーザでは実行できません。
連続して再起動を要求することはできません。

例外:

SalesforceStreamingClientException - 再起動に失敗した場合に発生します。

registerTopic

public int registerTopic(Topic topic)
                  throws SalesforceStreamingClientException

トピックを登録します。

パラメータ:

topic - トピック

戻り値:

更新されたレコード数

例外:

SalesforceStreamingClientException - トピックの登録に失敗した場合に発生します。

restartAllSessions

public void restartAllSessions()
                        throws SalesforceStreamingClientException

全ての Salesforce Streaming セッションをリスタートします。
一般ユーザでは実行できません。

例外:

SalesforceStreamingClientException - セッションのリスタートに失敗した場合に発生します。

restartSession

public void restartSession(String sessionId)
                    throws SalesforceStreamingClientException

指定された Salesforce Streaming セッションをリスタートします。

パラメータ:

sessionId - Salesforce StreamingのセッションID

例外:

SalesforceStreamingClientException - セッションのリスタートに失敗した場合に発生します。

stopSession

public void stopSession(String sessionId)
                 throws SalesforceStreamingClientException

指定された Salesforce Streaming セッションを停止します。

パラメータ:

sessionId - Salesforce StreamingのセッションID

例外:

SalesforceStreamingClientException - セッションの停止に失敗した場合に発生します。

unregisterTopic

public int unregisterTopic(Topic topic)
                    throws SalesforceStreamingClientException

トピックを削除します。

パラメータ:

topic - トピック

戻り値:

更新されたレコード数

例外:

SalesforceStreamingClientException - トピックの削除に失敗した場合に発生します。

updateTopic

public int updateTopic(Topic topic)
                throws SalesforceStreamingClientException

トピックを更新します

パラメータ:

topic - トピック

戻り値:

更新されたレコード数

例外:

SalesforceStreamingClientException - トピックの更新に失敗した場合に発生します。

getRepository

protected jp.co.intra_mart.system.salesforce.streaming.repository.SalesforceTopicRepository getRepository()

SalesforceTopicRepository を取得します。

戻り値:

SalesforceTopicRepository

getService

protected jp.co.intra_mart.system.salesforce.streaming.service.SalesforceStreamingClientService getService()

SalesforceStreamingClientService を取得します。

戻り値:

SalesforceStreamingClientService