Интерфейс контекста
- Все известные подинтерфейсы:
-
DirContext,EventContext,EventDirContext,LdapContext
- Все известные реализующие классы:
-
InitialContext,InitialDirContext,InitialLdapContext
public interface Context
Имена
Каждое имя, переданное в качестве аргумента методуContext, относительно этого контекста. Пустое имя используется для именования самого контекста. Параметр имени никогда не может быть null. Большинство методов имеют перегруженные версии, одна из которых принимает параметр Name, а другая — String. Эти перегруженные версии эквивалентны в том, что если параметры Name и String представляют одно и то же имя, то перегруженные версии одних и тех же методов ведут себя одинаково. В описаниях методов ниже приводится только одна версия, которая полностью документирована. Вторая версия содержит ссылку на первую: данная документация применима к обеим версиям.
Для систем, поддерживающих федерацию, параметры имени, передаваемые методам Context, являются составными именами. Параметры имени, которые являются экземплярами CompositeName, обрабатываются как составные имена, в то время как параметры имен, которые не являются экземплярами CompositeName, обрабатываются как составные имена (которые могут быть экземплярами CompoundName или других реализаций составных имен). Это позволяет использовать результаты NameParser.parse() в качестве аргументов для методов Context. До JNDI 1.2 все аргументы имени обрабатывались как составные имена.
Кроме того, для систем, поддерживающих федерацию, все имена, возвращаемые в NamingEnumeration методами list() и listBindings(), представляют собой составные имена, представленные в виде строк. См. CompositeName для синтаксиса строк имен.
Для систем, не поддерживающих федерацию, аргументы имен (в формате Name или String) и имена, возвращаемые в NamingEnumeration, могут быть именами в их собственном пространстве имен, а не именами в составном пространстве имен, по усмотрению поставщика услуг.
Исключения
Все методы в этом интерфейсе могут вызывать исключениеNamingException или любой его подкласс. См. NamingException и их подклассы для получения подробной информации об каждом исключении. Одновременный доступ
Для экземпляра Context нет гарантии синхронизации против одновременного доступа с помощью нескольких потоков. Потоки, которым нужно получить одновременный доступ к одному экземпляру Context, должны синхронизироваться между собой и обеспечивать необходимую блокировку. Несколько потоков, каждый из которых манипулирует разными экземплярами Context, синхронизироваться не должны. Обратите внимание, что методlookup, когда ему передано пустое имя, вернет новый экземпляр Context, представляющий тот же контекст именования. Для целей управления одновременностью операция Context, которая возвращает NamingEnumeration, не считается завершенной, пока перечисление все еще используется или пока любые ссылки, созданные этой операцией, все еще следуют.
Параметры
ПараметрName, переданный любому методу интерфейса Context или одному из его подинтерфейсов, не будет изменен поставщиком услуг. Поставщик услуг может сохранить ссылку на него на протяжении всей операции, включая перечисление результатов метода и обработку любых ссылок, генерируемых. Вызывающая сторона не должна изменять объект в течение этого времени. Объект Name, возвращаемый любым таким методом, принадлежит вызывающей стороне. Вызывающая сторона может впоследствии изменить его; поставщик услуг не может. Свойства среды
Приложения JNDI нуждаются в способе передачи различных настроек и свойств, которые определяют среду, в которой осуществляется доступ к службам именования и каталогов. Например, контексту может потребоваться указание учетных данных безопасности для доступа к службе. Другой контекст может потребовать предоставления информации о конфигурации сервера. Это называется окружением контекста. Интерфейс Context предоставляет методы для извлечения и обновления этого окружения.
Окружение наследуется от родительского контекста по мере того, как методы контекста переходят от одного контекста к другому. Изменения в окружении одного контекста не влияют напрямую на другие контексты.
Время использования и проверки свойств среды зависит от реализации. Например, некоторые свойства, связанные с безопасностью, используются поставщиками услуг для "входа" в каталог. Этот процесс входа может происходить при создании контекста или при первом вызове метода контекста. Когда и произойдет ли это вообще, зависит от реализации. При добавлении или удалении свойств среды из контекста проверка их корректности также зависит от реализации. Например, проверка некоторых свойств может происходить в момент внесения изменения, или в момент выполнения следующей операции над контекстом, или вообще не происходить.
Любой объект, имеющий ссылку на контекст, может просматривать окружение этого контекста. Чувствительная информация, такая как пароли в открытом тексте, не должна храниться там, если не известно, что реализация ее защищает.
Файлы ресурсов
Чтобы упростить задачу настройки окружения, необходимого приложению JNDI, компоненты приложений и поставщики услуг могут распространяться вместе с файлами ресурсов. Файл ресурсов JNDI — это файл в формате файла свойств (см. java.util.Properties), содержащий список пар "ключ-значение". Ключ — это имя свойства (например, "java.naming.factory.object"), а значение — строка в формате, определенном для этого свойства. Вот пример файла ресурсов JNDI:
java.naming.factory.object=com.sun.jndi.ldap.AttrsToCorba:com.wiz.from.Person
java.naming.factory.state=com.sun.jndi.ldap.CorbaToAttrs:com.wiz.from.Person
java.naming.factory.control=com.sun.jndi.ldap.ResponseControlFactory
Библиотека классов JNDI считывает файлы ресурсов и делает значения свойств доступными. Таким образом, файлы ресурсов JNDI следует считать "доступными для чтения всеми", и чувствительная информация, такая как пароли в открытом тексте, не должна храниться в них. Существует два типа файлов ресурсов JNDI: поставщика и приложения.
Файлы ресурсов поставщика
У каждого поставщика услуг есть необязательный ресурс, который перечисляет свойства, специфичные для этого поставщика. Название этого ресурса: [префикс/]jndiprovider.properties где префикс — имя пакета реализации контекста поставщика, где каждая точка (".") заменяется слешем ("/"). Например, предположим, что поставщик услуг определяет реализацию контекста с именем класса com.sun.jndi.ldap.LdapCtx. Файл ресурсов поставщика для этого поставщика называется com/sun/jndi/ldap/jndiprovider.properties. Если класс не находится в пакете, имя ресурса просто jndiprovider.properties. Некоторые методы в библиотеке классов JNDI используют стандартные свойства JNDI, которые задают списки JNDI-фабрик:
- java.naming.factory.object
- java.naming.factory.state
- java.naming.factory.control
- java.naming.factory.url.pkgs
Файлы ресурсов приложения
Когда приложение развернуто, в его пути к классам обычно присутствует несколько каталогов кода и JAR-файлов. JNDI находит (используяClassLoader.getResources()) все файлы ресурсов приложения с именем jndi.properties в пути к классам. Кроме того, если каталог установки Java содержит встроенный файл свойств, обычно conf/jndi.properties, JNDI обрабатывает его как дополнительный файл ресурсов приложения. Все свойства, содержащиеся в этих файлах, помещаются в окружение начального контекста. Затем это окружение наследуется другими контекстами. Для каждого свойства, найденного в более чем одном файле ресурсов приложения, JNDI использует первое найденное значение или, в некоторых случаях, когда это имеет смысл, конкатенирует все значения (подробности приведены ниже). Например, если свойство "java.naming.factory.object" найдено в трех файлах ресурсов приложения, список фабрик объектов представляет собой конкатенацию значений свойства из всех трех файлов. Используя эту схему, каждый развертываемый компонент отвечает за перечисление экспортируемых им фабрик. JNDI автоматически собирает и использует все эти списки экспорта при поиске классов фабрик.
Алгоритм поиска свойств
При создании начального контекста JNDI окружение контекста инициализируется свойствами, определенными в параметре окружения, переданном в конструктор, свойствами системы и файлами ресурсов приложения. См.InitialContext для получения подробной информации. Затем это начальное окружение наследуется другими экземплярами контекста. Когда библиотека JNDI должна определить значение свойства, она делает это, объединяя значения из двух следующих источников в указанном порядке:
- Окружение контекста, с которым ведется работа.
- Файл ресурсов поставщика (
jndiprovider.properties) для контекста, с которым ведется работа.
Когда поставщику услуг нужно определить значение свойства, он обычно берет это значение непосредственно из окружения. Поставщик услуг может определить специфичные для поставщика свойства, которые помещаются в собственный файл ресурсов поставщика. В этом случае он должен объединять значения, как описано в предыдущем абзаце.
Таким образом, каждый разработчик поставщика услуг может указать список фабрик, которые следует использовать с этим поставщиком услуг. Эти фабрики могут быть изменены ресурсами приложения, указанными развертывателем приложения, которые, в свою очередь, могут быть изменены пользователем.
- С:
- 1.3
Краткое описание полей
| Модификатор и тип | Поле | Описание |
|---|---|---|
static final String |
APPLET |
Устаревшее, для удаления: Этот элемент API может быть удален в будущей версии. Свойство среды с этим именем игнорируется при построении начального контекста. |
static final String |
AUTHORITATIVE |
Константа, содержащая имя свойства среды для указания авторитетности запрашиваемой службы. |
static final String |
BATCHSIZE |
Константа, содержащая имя свойства среды для указания размера пакета для возврата данных через протокол службы. |
static final String |
DNS_URL |
Константа, содержащая имя свойства среды для указания хоста и домена DNS для использования в контексте URL JNDI (например, "dns://somehost/wiz.com"). |
static final String |
INITIAL_CONTEXT_FACTORY |
Константа, содержащая имя свойства среды для указания фабрики начального контекста для использования. |
static final String |
LANGUAGE |
Константа, содержащая имя свойства среды для указания предпочтительного языка для использования с службой. |
static final String |
OBJECT_FACTORIES |
Константа, содержащая имя свойства среды для указания списка фабрик объектов для использования. |
static final String |
PROVIDER_URL |
Константа, содержащая имя свойства среды для указания конфигурационной информации для использования поставщиком службы. |
static final String |
REFERRAL |
Константа, содержащая имя свойства среды для указания того, как должны обрабатываться перенаправления, обнаруженные поставщиком службы. |
static final String |
SECURITY_AUTHENTICATION |
Константа, содержащая имя свойства среды для указания уровня безопасности для использования. |
static final String |
SECURITY_CREDENTIALS |
Константа, содержащая имя свойства среды для указания учетных данных принципала для аутентификации вызывающего абонента к службе. |
static final String |
SECURITY_PRINCIPAL |
Константа, содержащая имя свойства среды для указания идентификатора принципала для аутентификации вызывающего абонента к службе. |
static final String |
SECURITY_PROTOCOL |
Константа, содержащая имя свойства среды для указания протокола безопасности для использования. |
static final String |
STATE_FACTORIES |
Константа, содержащая имя свойства среды для указания списка фабрик состояния для использования. |
static final String |
URL_PKG_PREFIXES |
Константа, содержащая имя свойства среды для указания списка префиксов пакетов для использования при загрузке фабрик контекстов URL. |
Краткое описание методов
| Модификатор и тип | Метод | Описание |
|---|---|---|
Object |
addToEnvironment |
Добавляет новое свойство среды в среду этого контекста. |
void |
bind |
Связывает имя с объектом. |
void |
bind |
Связывает имя с объектом. |
void |
close() |
Закрывает этот контекст. |
String |
composeName |
Компонует имя этого контекста с именем, относящимся к этому контексту. |
Name |
composeName |
Компонует имя этого контекста с именем, относящимся к этому контексту. |
Context |
createSubcontext |
Создает и связывает новый контекст. |
Context |
createSubcontext |
Создает и связывает новый контекст. |
void |
destroySubcontext |
Уничтожает именованный контекст и удаляет его из пространства имен. |
void |
destroySubcontext |
Уничтожает именованный контекст и удаляет его из пространства имен. |
Hashtable<?, |
getEnvironment() |
Получает среду, действующую для этого контекста. |
String |
getNameInNamespace() |
Получает полное имя этого контекста в его собственном пространстве имен. |
NameParser |
getNameParser |
Получает парсер, связанный с именованным контекстом. |
NameParser |
getNameParser |
Получает парсер, связанный с именованным контекстом. |
NamingEnumeration<NameClassPair> |
list |
Перечисляет имена, связанные в именованном контексте, вместе с именами классов объектов, связанных с ними. |
NamingEnumeration<NameClassPair> |
list |
Перечисляет имена, связанные в именованном контексте, вместе с именами классов объектов, связанных с ними. |
NamingEnumeration<Binding> |
listBindings |
Перечисляет имена, связанные в именованном контексте, вместе с самими связанными объектами. |
NamingEnumeration<Binding> |
listBindings |
Перечисляет имена, связанные в именованном контексте, вместе с самими связанными объектами. |
Object |
lookup |
Получает именованный объект. |
Object |
lookup |
Получает именованный объект. |
Object |
lookupLink |
Получает именованный объект, переходя по ссылкам, за исключением конечного атомарного компонента имени. |
Object |
lookupLink |
Получает именованный объект, переходя по ссылкам, за исключением конечного атомарного компонента имени. |
void |
rebind |
Связывает имя с объектом, перезаписывая любое существующее связывание. |
void |
rebind |
Связывает имя с объектом, перезаписывая любое существующее связывание. |
Object |
removeFromEnvironment |
Удаляет свойство среды из среды этого контекста. |
void |
rename |
Связывает новое имя с объектом, связанным со старым именем, и отвязывает старое имя. |
void |
rename |
Связывает новое имя с объектом, связанным со старым именем, и отвязывает старое имя. |
void |
unbind |
Отвязывает именованный объект. |
void |
unbind |
Отвязывает именованный объект. |
Подробное описание полей
INITIAL_CONTEXT_FACTORY
static final String INITIAL_CONTEXT_FACTORY
NoInitialContextException. Значение этой константы равно "java.naming.factory.initial".
OBJECT_FACTORIES
static final String OBJECT_FACTORIES
Значение этой константы равно "java.naming.factory.object".
STATE_FACTORIES
static final String STATE_FACTORIES
Значение этой константы равно "java.naming.factory.state".
URL_PKG_PREFIXES
static final String URL_PKG_PREFIXES
com.sun.jndi.url всегда добавляется к возможно пустому списку префиксов пакетов. Значение этой константы равно "java.naming.factory.url.pkgs".
- См. также:
PROVIDER_URL
static final String PROVIDER_URL
Значение этой константы равно "java.naming.provider.url".
DNS_URL
static final String DNS_URL
ConfigurationException. Значение этой константы равно "java.naming.dns.url".
AUTHORITATIVE
static final String AUTHORITATIVE
Значение этой константы равно "java.naming.authoritative".
BATCHSIZE
static final String BATCHSIZE
Значение этой константы равно "java.naming.batchsize".
REFERRAL
static final String REFERRAL
- "follow"
- автоматически следовать перенаправлениям
- "ignore"
- игнорировать перенаправления
- "throw"
- выбрасывать
ReferralExceptionпри встрече перенаправления.
Значение этой константы равно "java.naming.referral".
ПРОТОКОЛ_БЕЗОПАСНОСТИ
static final String SECURITY_PROTOCOL
Значение этой константы — «java.naming.security.protocol».
АВТОРИЗАЦИЯ_БЕЗОПАСНОСТИ
static final String SECURITY_AUTHENTICATION
Значение этой константы — «java.naming.security.authentication».
СУЩНОСТЬ_БЕЗОПАСНОСТИ
static final String SECURITY_PRINCIPAL
Значение этой константы — «java.naming.security.principal».
КРЕДИЕНЦИАЛЫ_БЕЗОПАСНОСТИ
static final String SECURITY_CREDENTIALS
Значение этой константы — «java.naming.security.credentials».
ЯЗЫК
static final String LANGUAGE
Значение этой константы — «java.naming.language».
АПЛЕТ
@Deprecated(since="9", forRemoval=true) static final String APPLET
Applet для извлечения параметров при создании начального контекста. В настоящее время любые свойства апплетов, которые нужно передать в начальный контекст, должны быть скопированы в хеш-таблицу окружения:
Hashtable env = new Hashtable();
env.put(Context.INITIAL_CONTEXT_FACTORY,
((Applet) this).getParameter(Context.INITIAL_CONTEXT_FACTORY));
env.put(Context.PROVIDER_URL,
((Applet) this).getParameter(Context.PROVIDER_URL));
// ... other properties ...
Context ctx = new InitialContext(env);
- С:
- 1.3
- См. также:
Подробное описание методов
lookup
Object lookup(Name name) throws NamingException
name пусто, возвращает новую инстанцию этого контекста (представляющая тот же контекст именования, что и этот контекст, но его среда может быть изменена независимо и к ней можно обращаться одновременно).- Параметры:
-
name- имя искомого объекта - Возвращает:
- объект, связанный с
name - Исключения:
-
NamingException- если возникло исключение именования - См. также:
lookup
Object lookup(String name) throws NamingException
lookup(Name) для подробностей.- Параметры:
-
name- имя искомого объекта - Возвращает:
- объект, связанный с
name - Исключения:
-
NamingException- если возникло исключение именования
bind
void bind(Name name, Object obj) throws NamingException
- Параметры:
-
name- имя для связывания; не должно быть пустым -
obj- объект для связывания; возможно null - Исключения:
-
NameAlreadyBoundException- если имя уже связано -
InvalidAttributesException- если объект не предоставил все обязательные атрибуты -
NamingException- если возникло исключение именования - См. также:
bind
void bind(String name, Object obj) throws NamingException
bind(Name, Object) для подробностей.- Параметры:
-
name- имя для связывания; не должно быть пустым -
obj- объект для связывания; возможно null - Исключения:
-
NameAlreadyBoundException- если имя уже связано -
InvalidAttributesException- если объект не предоставил все обязательные атрибуты -
NamingException- если возникло исключение именования
rebind
void rebind(Name name, Object obj) throws NamingException
Если объект является DirContext, любые существующие атрибуты, связанные с именем, заменяются атрибутами объекта. В противном случае любые существующие атрибуты, связанные с именем, остаются неизменными.
- Параметры:
-
name- имя для связывания; не должно быть пустым -
obj- объект для связывания; возможно null - Исключения:
-
InvalidAttributesException- если объект не предоставил все обязательные атрибуты -
NamingException- если возникло исключение именования - См. также:
rebind
void rebind(String name, Object obj) throws NamingException
rebind(Name, Object) для подробностей.- Параметры:
-
name- имя для связывания; не должно быть пустым -
obj- объект для связывания; возможно null - Исключения:
-
InvalidAttributesException- если объект не предоставил все обязательные атрибуты -
NamingException- если возникло исключение именования
unbind
void unbind(Name name) throws NamingException
name из целевого контекста — того, который указан всеми, кроме конечной атомарной части name. Этот метод идемпотентен. Он выполняется успешно даже если конечное атомарное имя не связано в целевом контексте, но вызывает NameNotFoundException , если какой-либо из промежуточных контекстов не существует.
Все атрибуты, связанные с именем, удаляются. Промежуточные контексты не изменяются.
- Parameters:
-
name- имя для удаления; не может быть пустым - Throws:
-
NameNotFoundException- если промежуточный контекст не существует -
NamingException- если возникает исключение при именовании - See Also:
unbind
void unbind(String name) throws NamingException
unbind(Name).- Parameters:
-
name- имя для удаления; не может быть пустым - Throws:
-
NameNotFoundException- если промежуточный контекст не существует -
NamingException- если возникает исключение при именовании
rename
void rename(Name oldName, Name newName) throws NamingException
- Parameters:
-
oldName- имя существующей связи; не может быть пустым -
newName- имя новой связи; не может быть пустым - Throws:
-
NameAlreadyBoundException- еслиnewNameуже связано -
NamingException- если возникает исключение при именовании - See Also:
rename
void rename(String oldName, String newName) throws NamingException
rename(Name, Name).- Parameters:
-
oldName- имя существующей связи; не может быть пустым -
newName- имя новой связи; не может быть пустым - Throws:
-
NameAlreadyBoundException- еслиnewNameуже связано -
NamingException- если возникает исключение при именовании
list
NamingEnumeration<NameClassPair> list(Name name) throws NamingException
Если привязка добавляется или удаляется из этого контекста, её влияние на ранее возвращённый перечисление не определено.
- Parameters:
-
name- имя контекста для перечисления - Returns:
- перечисление имён и имён классов связей в этом контексте. Каждый элемент перечисления типа
NameClassPair. - Throws:
-
NamingException- если возникает исключение при именовании - See Also:
list
NamingEnumeration<NameClassPair> list(String name) throws NamingException
list(Name).- Parameters:
-
name- имя контекста для перечисления - Returns:
- перечисление имён и имён классов связей в этом контексте. Каждый элемент перечисления типа
NameClassPair. - Throws:
-
NamingException- если возникает исключение при именовании
listBindings
NamingEnumeration<Binding> listBindings(Name name) throws NamingException
Если привязка добавляется или удаляется из этого контекста, её влияние на ранее возвращённый перечисление не определено.
- Parameters:
-
name- имя контекста для перечисления - Returns:
- перечисление связей в этом контексте. Каждый элемент перечисления типа
Binding. - Throws:
-
NamingException- если возникает исключение при именовании - See Also:
listBindings
NamingEnumeration<Binding> listBindings(String name) throws NamingException
listBindings(Name).- Parameters:
-
name- имя контекста для перечисления - Returns:
- перечисление связей в этом контексте. Каждый элемент перечисления типа
Binding. - Throws:
-
NamingException- если возникает исключение при именовании
destroySubcontext
void destroySubcontext(Name name) throws NamingException
Этот метод идемпотентен. Он выполняется успешно даже если конечное атомарное имя не связано в целевом контексте, но вызывает NameNotFoundException , если какой-либо из промежуточных контекстов не существует.
В федеративной системе именования контекст из одной системы именования может быть связан с именем в другой. Затем можно найти и выполнить операции с внешним контекстом с помощью составного имени. Однако попытка уничтожить контекст с помощью этого составного имени завершится ошибкой NotContextException, поскольку внешний контекст не является "подконтекстом" контекста, в котором он связан. Вместо этого используйте unbind() для удаления привязки внешнего контекста. Для уничтожения внешнего контекста необходимо выполнить destroySubcontext() в контексте из "родной" системы именования внешнего контекста.
- Parameters:
-
name- имя контекста для удаления; не может быть пустым - Throws:
-
NameNotFoundException- если промежуточный контекст не существует -
NotContextException- если имя связано, но не является именем контекста или не является контекстом соответствующего типа -
ContextNotEmptyException- если именованный контекст не пуст -
NamingException- если возникает исключение при именовании - See Also:
destroySubcontext
void destroySubcontext(String name) throws NamingException
destroySubcontext(Name).- Parameters:
-
name- имя контекста для удаления; не может быть пустым - Throws:
-
NameNotFoundException- если промежуточный контекст не существует -
NotContextException- если имя связано, но не является именем контекста или не является контекстом соответствующего типа -
ContextNotEmptyException- если именованный контекст не пуст -
NamingException- если возникает исключение при именовании
createSubcontext
Context createSubcontext(Name name) throws NamingException
- Parameters:
-
name- имя создаваемого контекста; не может быть пустым - Returns:
- созданный контекст
- Throws:
-
NameAlreadyBoundException- если имя уже связано -
InvalidAttributesException- если для создания подконтекста требуется указание обязательных атрибутов -
NamingException- если возникает исключение при именовании - See Also:
createSubcontext
Context createSubcontext(String name) throws NamingException
createSubcontext(Name).- Parameters:
-
name- имя создаваемого контекста; не может быть пустым - Returns:
- созданный контекст
- Throws:
-
NameAlreadyBoundException- если имя уже связано -
InvalidAttributesException- если для создания подконтекста требуется указание обязательных атрибутов -
NamingException- если возникает исключение при именовании
lookupLink
Object lookupLink(Name name) throws NamingException
name, не является ссылкой, возвращается сам объект.- Parameters:
-
name- имя искомого объекта - Returns:
- объект, связанный с
name, без следования конечной ссылке (если таковая имеется). - Throws:
-
NamingException- если возникло исключение при работе с именованием - See Also:
lookupLink
Object lookupLink(String name) throws NamingException
lookupLink(Name).- Parameters:
-
name- имя искомого объекта - Returns:
- объект, связанный с
name, без следования конечной ссылке (если таковая имеется) - Throws:
-
NamingException- если возникло исключение при работе с именованием
getNameParser
NameParser getNameParser(Name name) throws NamingException
equals() тест).- Parameters:
-
name- имя контекста, для которого требуется получить парсер - Returns:
- парсер имен, который может разбить составные имена на их атомарные компоненты
- Throws:
-
NamingException- если возникло исключение при работе с именованием - See Also:
getNameParser
NameParser getNameParser(String name) throws NamingException
getNameParser(Name).- Parameters:
-
name- имя контекста, для которого требуется получить парсер - Returns:
- парсер имен, который может разбить составные имена на их атомарные компоненты
- Throws:
-
NamingException- если возникло исключение при работе с именованием
composeName
Name composeName(Name name, Name prefix) throws NamingException
name) относительно этого контекста и имя (prefix) этого контекста относительно одного из его предков, этот метод возвращает составное имя, используя синтаксис, соответствующий вовлечённой(ым) системе(ам) именования. То есть, если name именует объект относительно этого контекста, результат — имя того же объекта, но относительно контекста предка. Ни одно из имён не может быть null. Например, если этому контексту присвоено имя "wiz.com" относительно начального контекста, то
composeName("east", "wiz.com") может вернуть "east.wiz.com". Если вместо этого контексту присвоено имя "org/research", то
composeName("user/jane", "org/research") может вернуть "org/research/user/jane", а
composeName("user/jane", "research") возвращает "research/user/jane". - Parameters:
-
name- имя, относительное к данному контексту -
prefix- имя данного контекста относительно одного из его предков - Returns:
- составное имя из
prefixиname - Throws:
-
NamingException- если возникло исключение при работе с именованием - See Also:
composeName
String composeName(String name, String prefix) throws NamingException
composeName(Name, Name).- Parameters:
-
name- имя, относительное к данному контексту -
prefix- имя данного контекста относительно одного из его предков - Returns:
- составное имя из
prefixиname - Throws:
-
NamingException- если возникло исключение при работе с именованием
addToEnvironment
Object addToEnvironment(String propName, Object propVal) throws NamingException
- Parameters:
-
propName- имя свойства окружения для добавления; не может быть null -
propVal- значение свойства для добавления; не может быть null - Returns:
- предыдущее значение свойства или null, если свойство ранее не присутствовало в среде
- Throws:
-
NamingException- если возникло исключение при работе с именованием - See Also:
removeFromEnvironment
Object removeFromEnvironment(String propName) throws NamingException
- Parameters:
-
propName- имя свойства окружения для удаления; не может быть null - Returns:
- предыдущее значение свойства или null, если свойство не было в среде
- Throws:
-
NamingException- если возникло исключение при работе с именованием - See Also:
getEnvironment
Hashtable<?,?> getEnvironment() throws NamingException
Вызывающая сторона не должна вносить никаких изменений в возвращаемый объект: их влияние на контекст не определено. Среду данного контекста можно изменить с помощью addToEnvironment() и removeFromEnvironment().
- Returns:
- среда этого контекста; никогда не null
- Throws:
-
NamingException- если возникло исключение при работе с именованием - See Also:
close
void close() throws NamingException
Этот метод идемпотентен: вызов его для контекста, который уже закрыт, не оказывает никакого влияния. Вызов любого другого метода для закрытого контекста запрещён и приводит к неопределённому поведению.
- Throws:
-
NamingException- если возникло исключение при работе с именованием
getNameInNamespace
String getNameInNamespace() throws NamingException
Многие службы именования имеют понятие «полного имени» для объектов в своих соответствующих пространствах имён. Например, у записи LDAP есть выделенное имя, а у записи DNS — полностью квалифицированное имя. Этот метод позволяет клиентскому приложению получить это имя. Возвращаемая строка этим методом не является составным именем JNDI и не должна передаваться непосредственно методам контекста. В системах именования, для которых понятие полного имени не имеет смысла, выбрасывается OperationNotSupportedException.
- Returns:
- имя контекста в его собственном пространстве имён; никогда не null
- Throws:
-
OperationNotSupportedException- если система именования не имеет понятия полного имени -
NamingException- если возникло исключение при работе с именованием - Since:
- 1.3
© 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.naming/javax/naming/Context.html