RmiServiceExporter (Spring Framework 5.0.0.RELEASE API)

java.lang.ObjectSE
- org.springframework.remoting.support.RemotingSupport
- - org.springframework.remoting.support.RemoteExporter
  - - org.springframework.remoting.support.RemoteInvocationBasedExporter
    - - org.springframework.remoting.rmi.RmiBasedExporter
      - org.springframework.remoting.rmi.RmiServiceExporter

実装されているすべてのインターフェース:
Aware, BeanClassLoaderAware, DisposableBean, InitializingBean
```
public class RmiServiceExporter
extends RmiBasedExporter
implements InitializingBean, DisposableBean
```
指定したサービスを指定した名前の RMI オブジェクトとして公開する RMI エクスポーター。このようなサービスには、プレーンな RMI または RmiProxyFactoryBean を介してアクセスできます。RmiClientInterceptor/RmiProxyFactoryBean のそのような呼び出し側の自動検出を介してアクセスされる RMI 呼び出し側を介した非 RMI サービスの公開もサポートします。
RMI インボーカーを使用すると、RMI 通信は RmiInvocationHandler レベルで機能し、サービスに必要なスタブは 1 つだけです。サービスインターフェースは、すべてのメソッドで java.rmi.Remote を継承したり、java.rmi.RemoteException をスローしたりする必要はありませんが、入出力パラメーターは直列化可能でなければなりません。
Hessian と比較した RMI の主な利点は、直列化です。事実上、シリアライズ可能な Java オブジェクトは簡単に転送できます。Hessian には独自の（逆）直列化メカニズムがありますが、HTTP ベースであるため、RMI よりもセットアップがはるかに簡単です。または、Spring の HTTP インボーカーを考慮して、Java 直列化と HTTP ベースのトランスポートを組み合わせます。
メモ: RMI は、完全修飾ホスト名を取得するためのベストエフォートの試みを行います。判別できない場合は、フォールバックして IP アドレスを使用します。ネットワーク構成に応じて、場合によっては IP をループバックアドレスに解決します。RMI が正しいネットワークインターフェースにバインドされたホスト名を使用するようにするには、java.rmi.server.hostname プロパティを JVM に渡し、JVM 引数 "-D" を使用してレジストリまたはサービス、あるいはその両方をエクスポートする必要があります。たとえば: -Djava.rmi.server.hostname=myserver.com
導入:
13.05.2003
作成者:
Juergen Hoeller
関連事項:
RmiClientInterceptor, RmiProxyFactoryBean, RemoteSE, RemoteExceptionSE, HessianServiceExporter, HttpInvokerServiceExporter

フィールドのサマリー
- クラス org.springframework.remoting.support.RemotingSupport から継承されたフィールド
  logger

コンストラクターの概要
コンストラクター
コンストラクターと説明
RmiServiceExporter()

コンストラクター
コンストラクターと説明
`RmiServiceExporter()`

メソッドのサマリー

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`void`	`afterPropertiesSet()` 指定されたすべての Bean プロパティを設定した（そして BeanFactoryAware と ApplicationContextAware を満たした）後に BeanFactory によって呼び出されます。
`void`	`destroy()` Bean のファクトリシャットダウン時に、レジストリから RMI サービスをアンバインドします。
`protected RegistrySE`	`getRegistry(int registryPort)` このエクスポーターの RMI レジストリを見つけるか作成します。
`protected RegistrySE`	`getRegistry(int registryPort, RMIClientSocketFactorySE clientSocketFactory, RMIServerSocketFactorySE serverSocketFactory)` このエクスポーターの RMI レジストリを見つけるか作成します。
`protected RegistrySE`	`getRegistry(StringSE registryHost, int registryPort, RMIClientSocketFactorySE clientSocketFactory, RMIServerSocketFactorySE serverSocketFactory)` このエクスポーターの RMI レジストリを見つけるか作成します。
`void`	`prepare()` このサービスエクスポーターを初期化し、サービスを RMI オブジェクトとして登録します。
`void`	`setAlwaysCreateRegistry(boolean alwaysCreateRegistry)` 指定されたポートで既存のレジストリを見つけようとせずに、常にインプロセスでレジストリを作成するかどうかを設定します。
`void`	`setClientSocketFactory(RMIClientSocketFactorySE clientSocketFactory)` サービスのエクスポートに使用するカスタム RMI クライアントソケットファクトリを設定します。
`void`	`setRegistry(RegistrySE registry)` エクスポートされたサービスを登録する RMI レジストリを指定します。
`void`	`setRegistryClientSocketFactory(RMIClientSocketFactorySE registryClientSocketFactory)` RMI レジストリに使用するカスタム RMI クライアントソケットファクトリを設定します。
`void`	`setRegistryHost(StringSE registryHost)` エクスポートされた RMI サービスのレジストリのホストを設定します。
`void`	`setRegistryPort(int registryPort)` エクスポートされた RMI サービスのレジストリのポートを設定します。
`void`	`setRegistryServerSocketFactory(RMIServerSocketFactorySE registryServerSocketFactory)` RMI レジストリに使用するカスタム RMI サーバーソケットファクトリを設定します。
`void`	`setReplaceExistingBinding(boolean replaceExistingBinding)` RMI レジストリ内の既存のバインディングを置き換えるかどうか、つまり、レジストリ内で名前の競合が発生した場合に、指定されたサービスで既存のバインディングを単にオーバーライドするかどうかを設定します。
`void`	`setServerSocketFactory(RMIServerSocketFactorySE serverSocketFactory)` サービスのエクスポートに使用するカスタム RMI サーバーソケットファクトリを設定します。
`void`	`setServiceName(StringSE serviceName)` エクスポートされた RMI サービスの名前、つまり
`void`	`setServicePort(int servicePort)` エクスポートされた RMI サービスが使用するポートを設定します。
`protected void`	`testRegistry(RegistrySE registry)` 指定された RMI レジストリをテストし、その上で何らかの操作を呼び出して、まだアクティブかどうかを確認します。

クラス org.springframework.remoting.rmi.RmiBasedExporter から継承されたメソッド
getObjectToExport, invoke

クラス org.springframework.remoting.support.RemoteInvocationBasedExporter から継承されたメソッド
getRemoteInvocationExecutor, invokeAndCreateResult, setRemoteInvocationExecutor

クラス org.springframework.remoting.support.RemoteExporter から継承されたメソッド
checkService, checkServiceInterface, getExporterName, getProxyForService, getService, getServiceInterface, setInterceptors, setRegisterTraceInterceptor, setService, setServiceInterface

クラス org.springframework.remoting.support.RemotingSupport から継承されたメソッド
getBeanClassLoader, overrideThreadContextClassLoader, resetThreadContextClassLoader, setBeanClassLoader

クラス java.lang.ObjectSE から継承されたメソッド
cloneSE, equalsSE, finalizeSE, getClassSE, hashCodeSE, notifySE, notifyAllSE, toStringSE, waitSE, waitSE, waitSE

- コンストラクターの詳細
  - RmiServiceExporter
```
public RmiServiceExporter()
```
- メソッドの詳細
  - setServiceName
```
public void setServiceName(StringSE serviceName)
```
    エクスポートされた RMI サービスの名前、つまり rmi://host:port/NAME を設定します
  - setServicePort
```
public void setServicePort(int servicePort)
```
    エクスポートされた RMI サービスが使用するポートを設定します。
    デフォルトは 0（匿名ポート）です。
  - setClientSocketFactory
```
public void setClientSocketFactory(RMIClientSocketFactorySE clientSocketFactory)
```
    サービスのエクスポートに使用するカスタム RMI クライアントソケットファクトリを設定します。
    指定されたオブジェクトも java.rmi.server.RMIServerSocketFactory を実装している場合、サーバーソケットファクトリとしても自動的に登録されます。
    関連事項:
    setServerSocketFactory(java.rmi.server.RMIServerSocketFactory), RMIClientSocketFactorySE, RMIServerSocketFactorySE, UnicastRemoteObject.exportObject(Remote, int, RMIClientSocketFactory, RMIServerSocketFactory)SE
  - setServerSocketFactory
```
public void setServerSocketFactory(RMIServerSocketFactorySE serverSocketFactory)
```
    サービスのエクスポートに使用するカスタム RMI サーバーソケットファクトリを設定します。
    クライアントソケットファクトリが java.rmi.server.RMIServerSocketFactory をまだ実装していない場合にのみ指定する必要があります。
    関連事項:
    setClientSocketFactory(java.rmi.server.RMIClientSocketFactory), RMIClientSocketFactorySE, RMIServerSocketFactorySE, UnicastRemoteObject.exportObject(Remote, int, RMIClientSocketFactory, RMIServerSocketFactory)SE
  - setRegistry
```
public void setRegistry(RegistrySE registry)
```
    エクスポートされたサービスを登録する RMI レジストリを指定します。通常、RmiRegistryFactoryBean と組み合わせて使用されます。
    または、すべてのレジストリプロパティをローカルで指定できます。このエクスポータは、指定されたレジストリを見つけようとし、必要に応じて新しいローカルレジストリを自動的に作成します。
    デフォルトは、デフォルトポート (1099) のローカルレジストリであり、必要に応じてその場で作成されます。
    関連事項:
    RmiRegistryFactoryBean, setRegistryHost(java.lang.String), setRegistryPort(int), setRegistryClientSocketFactory(java.rmi.server.RMIClientSocketFactory), setRegistryServerSocketFactory(java.rmi.server.RMIServerSocketFactory)
  - setRegistryHost
```
public void setRegistryHost(StringSE registryHost)
```
    エクスポートされた RMI サービスのレジストリのホスト、つまり rmi://HOST:port/name を設定します
    デフォルトは localhost です。
  - setRegistryPort
```
public void setRegistryPort(int registryPort)
```
    エクスポートされた RMI サービスのレジストリのポート、つまり rmi://host:PORT/name を設定します
    デフォルトは Registry.REGISTRY_PORT (1099) です。
    関連事項:
    Registry.REGISTRY_PORTSE
  - setRegistryClientSocketFactory
```
public void setRegistryClientSocketFactory(RMIClientSocketFactorySE registryClientSocketFactory)
```
    RMI レジストリに使用するカスタム RMI クライアントソケットファクトリを設定します。
    指定されたオブジェクトも java.rmi.server.RMIServerSocketFactory を実装している場合、サーバーソケットファクトリとしても自動的に登録されます。
    関連事項:
    setRegistryServerSocketFactory(java.rmi.server.RMIServerSocketFactory), RMIClientSocketFactorySE, RMIServerSocketFactorySE, LocateRegistry.getRegistry(String, int, RMIClientSocketFactory)SE
  - setRegistryServerSocketFactory
```
public void setRegistryServerSocketFactory(RMIServerSocketFactorySE registryServerSocketFactory)
```
    RMI レジストリに使用するカスタム RMI サーバーソケットファクトリを設定します。
    クライアントソケットファクトリが java.rmi.server.RMIServerSocketFactory をまだ実装していない場合にのみ指定する必要があります。
    関連事項:
    setRegistryClientSocketFactory(java.rmi.server.RMIClientSocketFactory), RMIClientSocketFactorySE, RMIServerSocketFactorySE, LocateRegistry.createRegistry(int, RMIClientSocketFactory, RMIServerSocketFactory)SE
  - setAlwaysCreateRegistry
```
public void setAlwaysCreateRegistry(boolean alwaysCreateRegistry)
```
    指定されたポートで既存のレジストリを見つけようとせずに、常にインプロセスでレジストリを作成するかどうかを設定します。
    デフォルトは "false" です。常に新しいレジストリを作成する場合に、既存のレジストリを見つけるオーバーヘッドを回避するために、このフラグを "true" に切り替えます。
  - setReplaceExistingBinding
```
public void setReplaceExistingBinding(boolean replaceExistingBinding)
```
    RMI レジストリ内の既存のバインディングを置き換えるかどうか、つまり、レジストリ内で名前の競合が発生した場合に、指定されたサービスで既存のバインディングを単にオーバーライドするかどうかを設定します。
    デフォルトは "true" です。このエクスポーターのサービス名の既存のバインディングが、以前の実行からの偶発的な残りであると想定しています。このようなシナリオでエクスポーターを失敗させるには、これを "false" に切り替えて、バインド済みの RMI オブジェクトがすでに存在することを示します。
  - afterPropertiesSet
```
public void afterPropertiesSet()
                        throws RemoteExceptionSE
```
    インターフェースからコピーされた説明: InitializingBean
    指定されたすべての Bean プロパティを設定した（そして BeanFactoryAware と ApplicationContextAware を満たした）後に BeanFactory によって呼び出されます。
    このメソッドにより、Bean インスタンスは、すべての Bean プロパティが設定されている場合にのみ可能な初期化を実行し、設定ミスの場合に例外をスローできます。
    次で指定:
    インターフェース InitializingBean の afterPropertiesSet
    例外:
    RemoteExceptionSE
  - prepare
```
public void prepare()
             throws RemoteExceptionSE
```
    このサービスエクスポーターを初期化し、サービスを RMI オブジェクトとして登録します。
    指定されたポートに RMI レジストリが存在しない場合は作成します。
    例外:
    RemoteExceptionSE - サービス登録が失敗した場合
  - getRegistry
```
protected RegistrySE getRegistry(StringSE registryHost,
                               int registryPort,
                               @Nullable
                               RMIClientSocketFactorySE clientSocketFactory,
                               @Nullable
                               RMIServerSocketFactorySE serverSocketFactory)
                        throws RemoteExceptionSE
```
    このエクスポーターの RMI レジストリを見つけるか作成します。
    パラメーター:
    registryHost - 使用するレジストリホスト (これが指定されている場合、RMI レジストリの暗黙的な作成は行われません)
    registryPort - 使用するレジストリポート
    clientSocketFactory - レジストリの RMI クライアントソケットファクトリ (もしあれば)
    serverSocketFactory - レジストリの RMI サーバーソケットファクトリ (もしあれば)
    戻り値:
    RMI レジストリ
    例外:
    RemoteExceptionSE - レジストリを見つけられなかったか、作成できなかった場合
  - getRegistry
```
protected RegistrySE getRegistry(int registryPort,
                               @Nullable
                               RMIClientSocketFactorySE clientSocketFactory,
                               @Nullable
                               RMIServerSocketFactorySE serverSocketFactory)
                        throws RemoteExceptionSE
```
    このエクスポーターの RMI レジストリを見つけるか作成します。
    パラメーター:
    registryPort - 使用するレジストリポート
    clientSocketFactory - レジストリの RMI クライアントソケットファクトリ (もしあれば)
    serverSocketFactory - レジストリの RMI サーバーソケットファクトリ (もしあれば)
    戻り値:
    RMI レジストリ
    例外:
    RemoteExceptionSE - レジストリを見つけられなかったか、作成できなかった場合
  - getRegistry
```
protected RegistrySE getRegistry(int registryPort)
                        throws RemoteExceptionSE
```
    このエクスポーターの RMI レジストリを見つけるか作成します。
    パラメーター:
    registryPort - 使用するレジストリポート
    戻り値:
    RMI レジストリ
    例外:
    RemoteExceptionSE - レジストリを見つけられなかったか、作成できなかった場合
  - testRegistry
```
protected void testRegistry(RegistrySE registry)
                     throws RemoteExceptionSE
```
    指定された RMI レジストリをテストし、その上で何らかの操作を呼び出して、まだアクティブかどうかを確認します。
    デフォルトの実装は Registry.list() を呼び出します。
    パラメーター:
    registry - テストする RMI レジストリ
    例外:
    RemoteExceptionSE - レジストリメソッドによってスローされた場合
    関連事項:
    Registry.list()SE
  - destroy
```
public void destroy()
             throws RemoteExceptionSE
```
    Bean のファクトリシャットダウン時に、レジストリから RMI サービスをアンバインドします。
    次で指定:
    インターフェース DisposableBean の destroy
    例外:
    RemoteExceptionSE

クラス RmiServiceExporter

フィールドのサマリー

クラス org.springframework.remoting.support.RemotingSupport から継承されたフィールド

コンストラクターの概要

メソッドのサマリー

クラス org.springframework.remoting.rmi.RmiBasedExporter から継承されたメソッド

クラス org.springframework.remoting.support.RemoteInvocationBasedExporter から継承されたメソッド

クラス org.springframework.remoting.support.RemoteExporter から継承されたメソッド

クラス org.springframework.remoting.support.RemotingSupport から継承されたメソッド

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

コンストラクターの詳細

RmiServiceExporter

メソッドの詳細

setServiceName

setServicePort

setClientSocketFactory

setServerSocketFactory

setRegistry

setRegistryHost

setRegistryPort

setRegistryClientSocketFactory

setRegistryServerSocketFactory

setAlwaysCreateRegistry

setReplaceExistingBinding

afterPropertiesSet

prepare

getRegistry

getRegistry

getRegistry

testRegistry

destroy