Spec-Zone.ru › OpenJDK 17

Класс UnicastRemoteObject

java.lang.Object
java.rmi.server.RemoteObject
java.rmi.server.RemoteServer
java.rmi.server.UnicastRemoteObject
Все реализованные интерфейсы:
Serializable, Remote
public class UnicastRemoteObject extends RemoteServer
Используется для экспорта удаленного объекта с JRMP и получения заглушки (stub), которая взаимодействует с удаленным объектом. Заглушки генерируются во время выполнения с использованием динамических прокси-объектов.

Устаревшее: Статические заглушки. Поддержка статически сгенерированных заглушек устарела. Это включает API в этом классе, который требует использования статических заглушек, а также поддержку загрузки статических заглушек во время выполнения. Предпочтительным способом является динамическое создание заглушек, используя один из способов экспорта объектов, указанных ниже.

Существует восемь способов экспорта удаленных объектов:

  1. Наследование от UnicastRemoteObject и вызов конструктора UnicastRemoteObject().
  2. Наследование от UnicastRemoteObject и вызов конструктора UnicastRemoteObject(port).
  3. Наследование от UnicastRemoteObject и вызов конструктора UnicastRemoteObject(port, csf, ssf).
  4. Вызов метода exportObject(Remote). Устаревшее.
  5. Вызов метода exportObject(Remote, port).
  6. Вызов метода exportObject(Remote, port, csf, ssf).
  7. Вызов метода exportObject(Remote, port, filter).
  8. Вызов метода exportObject(Remote, port, csf, ssf, filter).

Четвёртый метод, exportObject(Remote), всегда использует статически сгенерированные заглушки и устарел.

Другие методы используют следующий подход: если свойство java.rmi.server.ignoreStubClasses имеет значение true (регистронезависимо) или если статическая заглушка не найдена, заглушки генерируются динамически с использованием объектов Proxy. В противном случае используются статические заглушки.

Значение свойства java.rmi.server.ignoreStubClasses по умолчанию равно false.

Статически сгенерированные заглушки обычно предварительно генерируются из класса удалённого объекта. Статическая заглушка загружается, и создаётся экземпляр этого класса заглушки, как описано ниже.

  • «Корневой класс» определяется следующим образом: если класс удалённого объекта напрямую реализует интерфейс, который расширяет Remote, то класс удалённого объекта является корневым классом; в противном случае корневым классом является наиболее производный суперкласс удалённого объекта, который напрямую реализует интерфейс, расширяющий Remote.
  • Имя класса заглушки для загрузки определяется путём конкатенации бинарного имени корневого класса с суффиксом _Stub.
  • Класс заглушки загружается по имени с помощью загрузчика классов корневого класса. Класс заглушки должен быть public, он должен наследоваться от RemoteStub, он должен находиться в пакете, который экспортирован, как минимум, в модуль java.rmi, и должен иметь public конструктор, который принимает один параметр типа RemoteRef.
  • Наконец, создаётся экземпляр класса заглушки с помощью RemoteRef.
  • Если соответствующий класс заглушки не найден, или класс заглушки не может быть загружен, или при создании экземпляра заглушки возникает проблема, будет брошено исключение StubNotFoundException.

Динамически сгенерированные заглушки создаются путём создания экземпляра Proxy со следующими характеристиками:

  • Класс прокси определяется в соответствии со спецификациями класса Proxy , используя загрузчик классов класса удалённого объекта.
  • Прокси реализует все удалённые интерфейсы, реализованные классом удалённого объекта.
  • Каждый удалённый интерфейс должен быть либо public и находиться в пакете, экспортированном, как минимум, в модуль java.rmi, либо он должен находиться в пакете, открытом, как минимум, для модуля java.rmi.
  • Обработчик вызовов прокси — это экземпляр RemoteObjectInvocationHandler, созданный с RemoteRef.
  • Если прокси не может быть создан, будет брошено исключение StubNotFoundException.

Экспортированные удалённые объекты получают вызовы методов от заглушек, как описано в спецификации RMI. Операция и параметры каждого вызова распаковываются с помощью настраиваемого ObjectInputStream. Если предоставлен ObjectInputFilter, который не null при экспорте объекта, он используется для фильтрации параметров во время распаковки из потока. Фильтр используется для всех вызовов и всех параметров независимо от вызываемого метода или значений параметров. Если не указан фильтр или он null для экспортированного объекта, используется ObjectInputStream фильтр по умолчанию, если таковой есть. Фильтр по умолчанию настроен с помощью ObjectInputFilter.Config.setSerialFilter. Если фильтр отклоняет любой из параметров, исключение InvalidClassException , брошенное ObjectInputStream , будет указано как причина исключения UnmarshalException.

Примечание реализации:
В зависимости от конструктора или статического метода, используемого для экспорта объекта, RMISocketFactory может использоваться для создания сокетов. По умолчанию серверные сокеты, созданные RMISocketFactory, слушают на всех сетевых интерфейсах. См. класс RMISocketFactory и раздел RMI Socket Factories в Спецификации Java RMI.
С:
1.1
См. также:
  • Сериализованная форма

Краткое описание полей

Поля, объявленные в классе java.rmi.server.RemoteObject

ref

Краткое описание конструкторов

UnicastRemoteObject()
UnicastRemoteObject(int port)
UnicastRemoteObject(int port, RMIClientSocketFactory csf, RMIServerSocketFactory ssf)
Модификатор Конструктор Описание
protected
Создаёт и экспортирует новый объект UnicastRemoteObject, используя анонимный порт.
protected
Создаёт и экспортирует новый объект UnicastRemoteObject, используя указанный порт.
protected
Создаёт и экспортирует новый объект UnicastRemoteObject, используя указанный порт и фабрики сокетов.

Краткое описание методов

Модификатор и тип Метод Описание
Object clone()
Возвращает клонированный удалённый объект, отличный от исходного.
static RemoteStub exportObject(Remote obj)
Устаревший.
Этот метод устарел, так как поддерживает только статические заглушки.
static Remote exportObject(Remote obj, int port)
Экспортирует удалённый объект, чтобы сделать его доступным для получения входящих вызовов, используя указанный порт.
static Remote exportObject(Remote obj, int port, ObjectInputFilter filter)
Экспортирует удалённый объект, чтобы сделать его доступным для получения входящих вызовов, используя указанный порт и фильтр.
static Remote exportObject(Remote obj, int port, RMIClientSocketFactory csf, RMIServerSocketFactory ssf)
Экспортирует удалённый объект, чтобы сделать его доступным для получения входящих вызовов, используя транспорт, указанный заданной фабрикой сокетов.
static Remote exportObject(Remote obj, int port, RMIClientSocketFactory csf, RMIServerSocketFactory ssf, ObjectInputFilter filter)
Экспортирует удалённый объект, чтобы сделать его доступным для получения входящих вызовов, используя транспорт, указанный заданной фабрикой сокетов и фильтр.
static boolean unexportObject(Remote obj, boolean force)
Удаляет удалённый объект, obj, из среды выполнения RMI.

Методы, объявленные в классе java.rmi.server.RemoteServer

getClientHost, getLog, setLog

Методы, объявленные в классе java.rmi.server.RemoteObject

equals, getRef, hashCode, toString, toStub

Методы, объявленные в классе java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Подробное описание конструкторов

UnicastRemoteObject

protected UnicastRemoteObject() throws RemoteException
Создаёт и экспортирует новый объект UnicastRemoteObject, используя анонимный порт.

Объект экспортируется с помощью сокета сервера, созданного с помощью класса RMISocketFactory.

Исключения:
RemoteException - если объект не удалось экспортировать
С момента:
1.1

UnicastRemoteObject

protected UnicastRemoteObject(int port) throws RemoteException
Создаёт и экспортирует новый объект UnicastRemoteObject, используя указанный порт.

Объект экспортируется с помощью сокета сервера, созданного с помощью класса RMISocketFactory.

Параметры:
port - номер порта, на котором удалённый объект получает вызовы (если port равно нулю, выбирается анонимный порт)
Исключения:
RemoteException - если объект не удалось экспортировать
С момента:
1.2

UnicastRemoteObject

protected UnicastRemoteObject(int port, RMIClientSocketFactory csf, RMIServerSocketFactory ssf) throws RemoteException
Создаёт и экспортирует новый объект UnicastRemoteObject, используя указанный порт и фабрики сокетов.

Любая из фабрик сокетов может быть null, в этом случае соответствующий метод создания сокета клиента или сервера из класса RMISocketFactory используется вместо неё.

Параметры:
port - номер порта, на котором удалённый объект получает вызовы (если port равно нулю, выбирается анонимный порт)
csf - фабрика сокетов для клиентской стороны для выполнения вызовов удалённого объекта
ssf - фабрика сокетов для серверной стороны для получения удалённых вызовов
Исключения:
RemoteException - если объект не удалось экспортировать
С момента:
1.2

Подробное описание методов

clone

public Object clone() throws CloneNotSupportedException
Возвращает клонированную копию удалённого объекта, отличную от оригинала.
Переопределяет:
clone в классе Object
Возвращает:
новый удалённый объект
Исключения:
CloneNotSupportedException - если клонирование завершилось ошибкой из-за RemoteException.
С момента:
1.1
См. также:
  • Cloneable

exportObject

@Deprecated public static RemoteStub exportObject(Remote obj) throws RemoteException
Устарело.
Этот метод устарел, так как поддерживает только статические заглушки. Используйте exportObject(Remote, port) или exportObject(Remote, port, csf, ssf) вместо него.
Экспортирует удалённый объект, чтобы он мог принимать входящие вызовы, используя анонимный порт. Этот метод всегда возвращает статически сгенерированную заглушку.

Объект экспортируется с помощью сокета сервера, созданного с помощью класса RMISocketFactory.

Параметры:
obj - удалённый объект для экспорта
Возвращает:
заглушка удалённого объекта
Исключения:
RemoteException - если экспорт не удался
С момента:
1.1

exportObject

public static Remote exportObject(Remote obj, int port) throws RemoteException
Экспортирует удалённый объект, чтобы он мог принимать входящие вызовы, используя указанный порт.

Объект экспортируется с помощью сокета сервера, созданного с помощью класса RMISocketFactory.

Параметры:
obj - удалённый объект для экспорта
port - порт для экспорта объекта
Возвращает:
заглушка удалённого объекта
Исключения:
RemoteException - если экспорт не удался
С момента:
1.2

exportObject

public static Remote exportObject(Remote obj, int port, RMIClientSocketFactory csf, RMIServerSocketFactory ssf) throws RemoteException
Экспортирует удалённый объект, чтобы он мог принимать входящие вызовы, используя транспорт, заданный данной фабрикой сокетов.

Любая из фабрик сокетов может быть null, в этом случае соответствующий метод создания сокета клиента или сервера из класса RMISocketFactory используется вместо неё.

Параметры:
obj - удалённый объект для экспорта
port - порт для экспорта объекта
csf - фабрика сокетов для клиентской стороны для выполнения вызовов удалённого объекта
ssf - фабрика сокетов для серверной стороны для получения удалённых вызовов
Возвращает:
заглушка удалённого объекта
Исключения:
RemoteException - если экспорт не удался
С момента:
1.2

exportObject

public static Remote exportObject(Remote obj, int port, ObjectInputFilter filter) throws RemoteException
Экспортирует удалённый объект, чтобы он мог принимать входящие вызовы, используя указанный порт и фильтр.

Объект экспортируется с помощью сокета сервера, созданного с помощью класса RMISocketFactory.

Параметры:
obj - удалённый объект для экспорта
port - порт для экспорта объекта
filter - объект ObjectInputFilter, применяемый при десериализации аргументов вызова; может быть null
Возвращает:
заглушка удалённого объекта
Исключения:
RemoteException - если экспорт не удался
С момента:
9

exportObject

public static Remote exportObject(Remote obj, int port, RMIClientSocketFactory csf, RMIServerSocketFactory ssf, ObjectInputFilter filter) throws RemoteException
Экспортирует удалённый объект, чтобы он мог принимать входящие вызовы, используя транспорт, заданный данной фабрикой сокетов и фильтром.

Любая из фабрик сокетов может быть null, в этом случае соответствующий метод создания сокета клиента или сервера из класса RMISocketFactory используется вместо неё.

Параметры:
obj - удалённый объект для экспорта
port - порт для экспорта объекта
csf - фабрика сокетов для клиентской стороны для выполнения вызовов удалённого объекта
ssf - фабрика сокетов для серверной стороны для получения удалённых вызовов
filter - объект ObjectInputFilter, применяемый при десериализации аргументов вызова; может быть null
Возвращает:
заглушка удалённого объекта
Исключения:
RemoteException - если экспорт не удался
С момента:
9

unexportObject

public static boolean unexportObject(Remote obj, boolean force) throws NoSuchObjectException
Удаляет удалённый объект, obj, из среды выполнения RMI. При успехе объект больше не может принимать входящие вызовы RMI. Если параметр force равен true, объект принудительно анэкспортируется, даже если есть ожидающие вызовы удалённого объекта или удалённый объект ещё выполняет вызовы. Если параметр force равен false, объект анэкспортируется только в том случае, если нет ожидающих или выполняющихся вызовов к объекту.
Параметры:
obj - удалённый объект для анэкспорта
force - если true, анэкспортирует объект, даже если есть ожидающие или выполняющиеся вызовы; если false, анэкспортирует объект только если нет ожидающих или выполняющихся вызовов
Возвращает:
true, если операция выполнена успешно, false в противном случае
Исключения:
NoSuchObjectException - если удалённый объект в данный момент не экспортирован
С момента:
1.2

© 1993, 2021, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/17/docs/api/java.rmi/java/rmi/server/UnicastRemoteObject.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API