Класс InitialContext
- java.lang.Object
-
- javax.naming.InitialContext
- Все реализованные интерфейсы:
- Context
- Прямые известные подклассы:
- InitialDirContext
public class InitialContext extends Object implements Context
Этот класс является начальным контекстом для выполнения операций именования.
Все операции именования относительны к контексту. Начальный контекст реализует интерфейс Context и предоставляет стартовую точку для разрешения имен.
При создании начального контекста его среда инициализируется свойствами, определенными в параметре среды, переданном в конструктор, и во всех файлах ресурсов приложения. Кроме того, небольшое количество стандартных свойств JNDI может быть указано в качестве системных свойств или параметров апплетов (через использование Context.APPLET). Эти специальные свойства перечислены в разделах описания полей интерфейса Context и LdapContext.
JNDI определяет значение каждого свойства, объединяя значения из следующих двух источников в указанном порядке:
- Первое вхождение свойства из параметра среды конструктора и (для соответствующих свойств) параметры апплетов и системные свойства.
- Файлы ресурсов приложения (
jndi.properties).
Context), все значения объединяются в один список, разделенный двоеточиями. Для других свойств используется только первое найденное значение. Реализация начального контекста определяется во время выполнения. Политика по умолчанию использует свойство среды "java.naming.factory.initial", которое содержит имя класса фабрики начального контекста. Исключение из этой политики делается при разрешении строковых значений URL, как описано ниже.
Когда строка URL (строка формата scheme_id:rest_of_name) передается в качестве параметра имени в любой метод, ищется и используется фабрика контекста URL для обработки данной схемы для разрешения URL. Если такая фабрика не найдена, используется начальный контекст, указанный в "java.naming.factory.initial". Аналогично, когда объект CompositeName, первый компонент которого является строкой URL, передается в качестве параметра имени в любой метод, ищется и используется фабрика контекста URL для разрешения первого компонента имени. См. для описания того, как ищутся фабрики контекстов URL.NamingManager.getURLContext()
По умолчанию политика поиска фабрик начального контекста и контекстов URL может быть переопределена вызовом NamingManager.setInitialContextFactoryBuilder().
Исключение NoInitialContextException возникает, когда начальный контекст не может быть создан. Это исключение может быть вызвано во время любого взаимодействия с InitialContext, а не только при создании InitialContext. Например, реализация начального контекста может лениво извлекать контекст только при вызове фактических методов. Приложение не должно зависеть от того, когда определяется существование начального контекста.
Если свойство среды "java.naming.factory.initial" не равно null, конструктор InitialContext попытается создать начальный контекст, указанный в нем. В этот момент фабрика начального контекста может выбросить исключение, если возникнет проблема. Однако, как и когда проверяются и сообщаются пользователям начального контекста проблемы со свойствами среды или подключением, зависит от реализации поставщика. Это может быть лениво — откладывая до выполнения операции с контекстом, или ревностно — в момент создания контекста.
Объект InitialContext не синхронизирован по отношению к одновременным доступам нескольких потоков. Несколько потоков, каждый из которых манипулирует разными экземплярами InitialContext, не нуждаются в синхронизации. Потоки, которым требуется одновременный доступ к одному экземпляру InitialContext, должны синхронизироваться между собой и обеспечивать необходимую блокировку.
- Дата выпуска:
- JNDI 1.1 / Java 2 Platform, Standard Edition, v 1.3
- См. также:
-
Context,NamingManager.setInitialContextFactoryBuilder
Поля
| Модификатор и тип | Поле и описание |
|---|---|
protected Context |
defaultInitCtx Поле, содержащее результат вызова NamingManager.getInitialContext(). |
protected boolean |
gotDefault Поле, указывающее, был ли начальный контекст получен путем вызова NamingManager.getInitialContext(). |
protected Hashtable<Object,Object> |
myProps Среда, связанная с этим InitialContext. |
Поля, унаследованные от интерфейса javax.naming.Context
APPLET, AUTHORITATIVE, BATCHSIZE, DNS_URL, INITIAL_CONTEXT_FACTORY, LANGUAGE, OBJECT_FACTORIES, PROVIDER_URL, REFERRAL, SECURITY_AUTHENTICATION, SECURITY_CREDENTIALS, SECURITY_PRINCIPAL, SECURITY_PROTOCOL, STATE_FACTORIES, URL_PKG_PREFIXES Конструкторы
| Модификатор | Конструктор и описание |
|---|---|
InitialContext() Создает начальный контекст. | |
protected |
InitialContext(boolean lazy) Создает начальный контекст с опцией не инициализировать его. |
InitialContext(Hashtable<?,?> environment) Создает начальный контекст, используя предоставленную среду. |
Методы
| Модификатор и тип | Метод и описание |
|---|---|
Object |
addToEnvironment(String propName,
Object propVal) Добавляет новое свойство среды в среду этого контекста. |
void |
bind(Name name,
Object obj) Связывает имя с объектом. |
void |
bind(String name,
Object obj) Связывает имя с объектом. |
void |
close() Закрывает этот контекст. |
Name |
composeName(Name name,
Name prefix) Компонует имя этого контекста с именем, относительным к этому контексту. |
String |
composeName(String name,
String prefix) Компонует имя этого контекста с именем, относительным к этому контексту. |
Context |
createSubcontext(Name name) Создает и связывает новый контекст. |
Context |
createSubcontext(String name) Создает и связывает новый контекст. |
void |
destroySubcontext(Name name) Уничтожает именованный контекст и удаляет его из пространства имен. |
void |
destroySubcontext(String name) Уничтожает именованный контекст и удаляет его из пространства имен. |
static <T> T |
doLookup(Name name) Статический метод для извлечения именованного объекта. |
static <T> T |
doLookup(String name) Статический метод для извлечения именованного объекта. |
protected Context |
getDefaultInitCtx() Получает начальный контекст, вызывая |
Hashtable<?,?> |
getEnvironment() Возвращает среду, действующую для этого контекста. |
String |
getNameInNamespace() Получает полное имя этого контекста в его собственном пространстве имен. |
NameParser |
getNameParser(Name name) Получает парсер, связанный с именованным контекстом. |
NameParser |
getNameParser(String name) Получает парсер, связанный с именованным контекстом. |
protected Context |
getURLOrDefaultInitCtx(Name name) Получает контекст для разрешения |
protected Context |
getURLOrDefaultInitCtx(String name) Получает контекст для разрешения строкового имени |
protected void |
init(Hashtable<?,?> environment) Инициализирует начальный контекст, используя предоставленную среду. |
NamingEnumeration<NameClassPair> |
list(Name name) Перечисляет имена, связанные в именованном контексте, вместе с именами классов объектов, связанных с ними. |
NamingEnumeration<NameClassPair> |
list(String name) Перечисляет имена, связанные в именованном контексте, вместе с именами классов объектов, связанных с ними. |
NamingEnumeration<Binding> |
listBindings(Name name) Перечисляет имена, связанные в именованном контексте, вместе с самими связанными объектами. |
NamingEnumeration<Binding> |
listBindings(String name) Перечисляет имена, связанные в именованном контексте, вместе с самими связанными объектами. |
Object |
lookup(Name name) Получает именованный объект. |
Object |
lookup(String name) Получает именованный объект. |
Object |
lookupLink(Name name) Получает именованный объект, следуя ссылкам, за исключением конечного атомарного компонента имени. |
Object |
lookupLink(String name) Получает именованный объект, следуя ссылкам, за исключением конечного атомарного компонента имени. |
void |
rebind(Name name,
Object obj) Связывает имя с объектом, перезаписывая любое существующее связывание. |
void |
rebind(String name,
Object obj) Связывает имя с объектом, перезаписывая любое существующее связывание. |
Object |
removeFromEnvironment(String propName) Удаляет свойство среды из среды этого контекста. |
void |
rename(Name oldName,
Name newName) Связывает новое имя с объектом, связанным со старым именем, и отвязывает старое имя. |
void |
rename(String oldName,
String newName) Связывает новое имя с объектом, связанным со старым именем, и отвязывает старое имя. |
void |
unbind(Name name) Отвязывает именованный объект. |
void |
unbind(String name) Отвязывает именованный объект. |
Методы, унаследованные от класса java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait Поля
myProps
protected Hashtable<Object,Object> myProps
Окружение, связанное с этим InitialContext. Инициализируется значением null и обновляется конструктором, принимающим окружение, или методом init().
- См. также:
-
addToEnvironment(java.lang.String, java.lang.Object),removeFromEnvironment(java.lang.String),getEnvironment()
defaultInitCtx
protected Context defaultInitCtx
Поле, содержащее результат вызова NamingManager.getInitialContext(). Устанавливается методом getDefaultInitCtx() при первом вызове. Последующие вызовы getDefaultInitCtx() возвращают значение defaultInitCtx.
- См. также:
getDefaultInitCtx()
gotDefault
protected boolean gotDefault
Поле, указывающее, был ли получен начальный контекст путём вызова NamingManager.getInitialContext(). Если true, результат находится в defaultInitCtx.
Конструкторы
InitialContext
protected InitialContext(boolean lazy)
throws NamingException Создаёт начальный контекст с опцией неинициализации. Может использоваться конструктором подкласса, когда значение параметра окружения ещё не известно во время вызова конструктора InitialContext. Конструктор подкласса вызовет этот конструктор, вычислит значение окружения и затем вызовет init(), прежде чем вернуть значение.
- Параметры:
-
lazy- true означает не инициализировать начальный контекст; false эквивалентно вызовуnew InitialContext() - Исключения:
-
NamingException- если возникло исключение именования - С тех пор:
- 1.3
- См. также:
init(Hashtable)
InitialContext
public InitialContext()
throws NamingException Создаёт начальный контекст. Свойства окружения не предоставляются. Эквивалентно new InitialContext(null).
- Исключения:
-
NamingException- если возникло исключение именования - См. также:
InitialContext(Hashtable)
InitialContext
public InitialContext(Hashtable<?,?> environment)
throws NamingException Создаёт начальный контекст, используя предоставленное окружение. Свойства окружения описаны в описании класса.
Этот конструктор не будет изменять environment или сохранять ссылку на него, но может сохранить копию. Вызывающий код не должен изменять изменяемые ключи и значения в environment после того, как они были переданы в конструктор.
- Параметры:
-
environment- окружение, используемое для создания начального контекста. Нулевое значение указывает на пустое окружение. - Исключения:
-
NamingException- если возникло исключение именования
Методы
init
protected void init(Hashtable<?,?> environment)
throws NamingException Инициализирует начальный контекст, используя предоставленное окружение. Свойства окружения описаны в описании класса.
Этот метод будет изменять environment и сохранит ссылку на него. Вызывающий код больше не сможет его изменять.
- Параметры:
-
environment- окружение, используемое для создания начального контекста. Нулевое значение указывает на пустое окружение. - Исключения:
-
NamingException- если возникло исключение именования - С тех пор:
- 1.3
- См. также:
InitialContext(boolean)
doLookup
public static <T> T doLookup(Name name)
throws NamingException Статический метод для получения объекта по имени. Это метод-костыль, эквивалентный вызову:
InitialContext ic = new InitialContext();
Object obj = ic.lookup();
Если name пусто, возвращает новый экземпляр этого контекста (который представляет тот же контекст именования, что и этот контекст, но его окружение может быть изменено независимо и к нему может быть обращено несколько раз).
- Типы параметров:
-
T- тип возвращаемого объекта - Параметры:
-
name- имя объекта для поиска - Возвращает:
- объект, связанный с
name - Исключения:
-
NamingException- если возникло исключение именования - С тех пор:
- 1.6
- См. также:
-
doLookup(String),lookup(Name)
doLookup
public static <T> T doLookup(String name)
throws NamingException Статический метод для получения объекта по имени. Подробнее см. doLookup(Name).
- Типы параметров:
-
T- тип возвращаемого объекта - Параметры:
-
name- имя объекта для поиска - Возвращает:
- объект, связанный с
name - Исключения:
-
NamingException- если возникло исключение именования - С тех пор:
- 1.6
getDefaultInitCtx
protected Context getDefaultInitCtx()
throws NamingException Получает начальный контекст, вызывая NamingManager.getInitialContext() и кэширует его в defaultInitCtx. Устанавливает gotDefault, чтобы мы знали, что пытались сделать это ранее.
- Возвращает:
- Не нулевой кэшированный начальный контекст.
- Исключения:
-
NoInitialContextException- Если не удалось найти начальный контекст. -
NamingException- Если возникло исключение именования.
getURLOrDefaultInitCtx
protected Context getURLOrDefaultInitCtx(String name)
throws NamingException Получает контекст для разрешения строкового имени name. Если имя name является строкой URL, то пытается найти контекст URL для него. Если таковой не найден, или имя name не является строкой URL, то возвращает getDefaultInitCtx().
См. getURLOrDefaultInitCtx(Name) для описания того, как подкласс должен использовать этот метод.
- Параметры:
-
name- Не нулевое имя, для которого требуется получить контекст. - Возвращает:
- Контекст URL для
nameили кэшированный начальный контекст. Результат не может быть null. - Исключения:
-
NoInitialContextException- Если не удалось найти начальный контекст. -
NamingException- Если возникло исключение именования. - См. также:
NamingManager.getURLContext(java.lang.String, java.util.Hashtable<?, ?>)
getURLOrDefaultInitCtx
protected Context getURLOrDefaultInitCtx(Name name)
throws NamingException Получает контекст для разрешения name. Если первый компонент имени name — строка URL, то пытается найти контекст URL для него. Если таковой не найден, или первый компонент name не является строкой URL, то возвращает getDefaultInitCtx().
При создании подкласса InitialContext используйте этот метод следующим образом. Определите новый метод, который использует этот метод для получения начального контекста нужного подкласса.
protected XXXContext getURLOrDefaultInitXXXCtx(Name name)
throws NamingException {
Context answer = getURLOrDefaultInitCtx(name);
if (!(answer instanceof XXXContext)) {
if (answer == null) {
throw new NoInitialContextException();
} else {
throw new NotContextException("Not an XXXContext");
}
}
return (XXXContext)answer;
} При предоставлении реализаций новых методов в подклассе используйте этот вновь определённый метод для получения начального контекста. public Object XXXMethod1(Name name, ...) {
throws NamingException {
return getURLOrDefaultInitXXXCtx(name).XXXMethod1(name, ...);
}
- Параметры:
-
name- Не нулевое имя, для которого требуется получить контекст. - Возвращает:
- Контекст URL для
nameили кэшированный начальный контекст. Результат не может быть null. - Исключения:
-
NoInitialContextException- Если не удалось найти начальный контекст. -
NamingException- Если возникло исключение именования. - См. также:
NamingManager.getURLContext(java.lang.String, java.util.Hashtable<?, ?>)
lookup
public Object lookup(String name)
throws NamingException Описание скопировано из интерфейса: Context
Получает объект по имени. Подробнее см. Context.lookup(Name).
- Определено в:
-
lookupв интерфейсеContext - Параметры:
-
name- имя объекта для поиска - Возвращает:
- объект, связанный с
name - Исключения:
-
NamingException- если возникло исключение именования
lookup
public Object lookup(Name name)
throws NamingException Описание скопировано из интерфейса: Context
Получает объект по имени. Если name пусто, возвращает новый экземпляр этого контекста (который представляет тот же контекст именования, что и этот контекст, но его окружение может быть изменено независимо и к нему может быть обращено несколько раз).
- Определено в:
-
lookupв интерфейсеContext - Параметры:
-
name- имя объекта для поиска - Возвращает:
- объект, связанный с
name - Исключения:
-
NamingException- если возникло исключение именования - См. также:
-
Context.lookup(String),Context.lookupLink(Name)
bind
public void bind(String name,
Object obj)
throws NamingException Описание скопировано из интерфейса: Context
Связывает имя с объектом. Подробнее см. Context.bind(Name, Object).
- Определено в:
-
bindв интерфейсеContext - Параметры:
-
name- имя для связывания; не может быть пустым -
obj- связываемый объект; может быть null - Исключения:
-
NameAlreadyBoundException- если имя уже связано -
InvalidAttributesException- если объект не предоставил все необходимые атрибуты -
NamingException- если возникло исключение именования
bind
public void bind(Name name,
Object obj)
throws NamingException Описание скопировано из интерфейса: Context
Связывает имя с объектом. Все промежуточные контексты и целевой контекст (названный всеми, кроме конечного атомарного компонента имени) должны уже существовать.
- Определено в:
-
bindв интерфейсеContext - Параметры:
-
name- имя для связывания; не может быть пустым -
obj- связываемый объект; может быть null - Исключения:
-
NameAlreadyBoundException- если имя уже связано -
InvalidAttributesException- если объект не предоставил все необходимые атрибуты -
NamingException- если возникло исключение именования - См. также:
-
Context.bind(String, Object),Context.rebind(Name, Object),DirContext.bind(Name, Object, javax.naming.directory.Attributes)
rebind
public void rebind(String name,
Object obj)
throws NamingException Описание скопировано из интерфейса: Context
Связывает имя с объектом, перезаписывая любое существующее связывание. Подробности см. в Context.rebind(Name, Object).
- Определено в:
-
rebindв интерфейсеContext - Параметры:
-
name- имя для связывания; не может быть пустым -
obj- объект для связывания; может быть null - Исключения:
-
InvalidAttributesException- если объект не предоставил все необходимые атрибуты -
NamingException- если возникло исключение при работе с именованием
rebind
public void rebind(Name name,
Object obj)
throws NamingException Описание скопировано из интерфейса: Context
Связывает имя с объектом, перезаписывая любое существующее связывание. Все промежуточные контексты и целевой контекст (названный всеми, кроме конечного атомарного компонента имени) должны уже существовать.
Если объект является DirContext, все существующие атрибуты, связанные с именем, заменяются атрибутами объекта. В противном случае все существующие атрибуты, связанные с именем, остаются неизменными.
- Определено в:
-
rebindв интерфейсеContext - Параметры:
-
name- имя для связывания; не может быть пустым -
obj- объект для связывания; может быть null - Исключения:
-
InvalidAttributesException- если объект не предоставил все необходимые атрибуты -
NamingException- если возникло исключение при работе с именованием - См. также:
-
Context.rebind(String, Object),Context.bind(Name, Object),DirContext.rebind(Name, Object, javax.naming.directory.Attributes),DirContext
unbind
public void unbind(String name)
throws NamingException Описание скопировано из интерфейса: Context
Отвязывает объект с указанным именем. Подробности см. в Context.unbind(Name).
- Определено в:
-
unbindв интерфейсеContext - Параметры:
-
name- имя для отвязки; не может быть пустым - Исключения:
-
NameNotFoundException- если промежуточный контекст не существует -
NamingException- если возникло исключение при работе с именованием
unbind
public void unbind(Name name)
throws NamingException Описание скопировано из интерфейса: Context
Отвязывает объект с указанным именем. Удаляет конечное атомарное имя в name из целевого контекста — контекста, названного всеми, кроме конечной атомарной части name.
Этот метод идемпотентен. Он выполняется успешно даже если конечное атомарное имя не связано в целевом контексте, но выбрасывает NameNotFoundException если любой из промежуточных контекстов не существует.
Все атрибуты, связанные с именем, удаляются. Промежуточные контексты не изменяются.
- Определено в:
-
unbindв интерфейсеContext - Параметры:
-
name- имя для отвязки; не может быть пустым - Исключения:
-
NameNotFoundException- если промежуточный контекст не существует -
NamingException- если возникло исключение при работе с именованием - См. также:
Context.unbind(String)
rename
public void rename(String oldName,
String newName)
throws NamingException Описание скопировано из интерфейса: Context
Связывает новое имя с объектом, связанным со старым именем, и отвязывает старое имя. Подробности см. в Context.rename(Name, Name).
- Определено в:
-
renameв интерфейсеContext - Параметры:
-
oldName- имя существующего связывания; не может быть пустым -
newName- имя нового связывания; не может быть пустым - Исключения:
-
NameAlreadyBoundException- еслиnewNameуже связано -
NamingException- если возникло исключение при работе с именованием
rename
public void rename(Name oldName,
Name newName)
throws NamingException Описание скопировано из интерфейса: Context
Связывает новое имя с объектом, связанным со старым именем, и отвязывает старое имя. Оба имени относительны к этому контексту. Все атрибуты, связанные со старым именем, становятся связанными с новым именем. Промежуточные контексты старого имени не изменяются.
- Определено в:
-
renameв интерфейсеContext - Параметры:
-
oldName- имя существующего связывания; не может быть пустым -
newName- имя нового связывания; не может быть пустым - Исключения:
-
NameAlreadyBoundException- еслиnewNameуже связано -
NamingException- если возникло исключение при работе с именованием - См. также:
-
Context.rename(String, String),Context.bind(Name, Object),Context.rebind(Name, Object)
list
public NamingEnumeration<NameClassPair> list(String name)
throws NamingException Описание скопировано из интерфейса: Context
Перечисляет имена, связанные в указанном контексте, вместе с именами классов объектов, связанных с ними. Подробности см. в Context.list(Name).
- Определено в:
-
listв интерфейсеContext - Параметры:
-
name- имя контекста для перечисления - Возвращает:
- перечисление имён и имён классов связываний в этом контексте. Каждый элемент перечисления имеет тип
NameClassPair. - Исключения:
-
NamingException- если возникло исключение при работе с именованием
list
public NamingEnumeration<NameClassPair> list(Name name)
throws NamingException Описание скопировано из интерфейса: Context
Перечисляет имена, связанные в указанном контексте, вместе с именами классов объектов, связанных с ними. Содержимое подконтекстов не включается.
Если к этому контексту добавляется или удаляется связывание, его влияние на перечисление, ранее возвращённое, не определено.
- Определено в:
-
listв интерфейсеContext - Параметры:
-
name- имя контекста для перечисления - Возвращает:
- перечисление имён и имён классов связываний в этом контексте. Каждый элемент перечисления имеет тип
NameClassPair. - Исключения:
-
NamingException- если возникло исключение при работе с именованием - См. также:
-
Context.list(String),Context.listBindings(Name),NameClassPair
listBindings
public NamingEnumeration<Binding> listBindings(String name)
throws NamingException Описание скопировано из интерфейса: Context
Перечисляет имена, связанные в указанном контексте, вместе с объектами, связанными с ними. Подробности см. в Context.listBindings(Name).
- Определено в:
-
listBindingsв интерфейсеContext - Параметры:
-
name- имя контекста для перечисления - Возвращает:
- перечисление связываний в этом контексте. Каждый элемент перечисления имеет тип
Binding. - Исключения:
-
NamingException- если возникло исключение при работе с именованием
listBindings
public NamingEnumeration<Binding> listBindings(Name name)
throws NamingException Описание скопировано из интерфейса: Context
Перечисляет имена, связанные в указанном контексте, вместе с объектами, связанными с ними. Содержимое подконтекстов не включается.
Если к этому контексту добавляется или удаляется связывание, его влияние на перечисление, ранее возвращённое, не определено.
- Определено в:
-
listBindingsв интерфейсеContext - Параметры:
-
name- имя контекста для перечисления - Возвращает:
- перечисление связываний в этом контексте. Каждый элемент перечисления имеет тип
Binding. - Исключения:
-
NamingException- если возникло исключение при работе с именованием - См. также:
-
Context.listBindings(String),Context.list(Name),Binding
destroySubcontext
public void destroySubcontext(String name)
throws NamingException Описание скопировано из интерфейса: Context
Уничтожает указанный контекст и удаляет его из пространства имён. Подробности см. в Context.destroySubcontext(Name).
- Определено в:
-
destroySubcontextв интерфейсеContext - Параметры:
-
name- имя контекста для уничтожения; не может быть пустым - Исключения:
-
NameNotFoundException- если промежуточный контекст не существует -
NotContextException- если имя связано, но не обозначает контекст, или обозначает контекст неподходящего типа -
ContextNotEmptyException- если указанный контекст не пустой -
NamingException- если возникло исключение при работе с именованием
destroySubcontext
public void destroySubcontext(Name name)
throws NamingException Описание скопировано из интерфейса: Context
Уничтожает указанный контекст и удаляет его из пространства имён. Все атрибуты, связанные с именем, также удаляются. Промежуточные контексты не уничтожаются.
Этот метод идемпотентен. Он выполняется успешно даже если конечное атомарное имя не связано в целевом контексте, но выбрасывает NameNotFoundException если любой из промежуточных контекстов не существует.
В федеративной системе именования контекст из одной системы именования может быть связан с именем в другой. Затем можно найти и выполнить операции с внешним контекстом, используя составное имя. Однако попытка уничтожить контекст с использованием этого составного имени завершится ошибкой NotContextException, так как внешний контекст не является «подконтекстом» контекста, в котором он связан. Вместо этого используйте unbind() для удаления связывания внешнего контекста. Для уничтожения внешнего контекста необходимо выполнить destroySubcontext() в контексте родной системы именования внешнего контекста.
- Определено в:
-
destroySubcontextв интерфейсеContext - Параметры:
-
name- имя контекста для уничтожения; не может быть пустым - Исключения:
-
NameNotFoundException- если промежуточный контекст не существует -
NotContextException- если имя связано, но не обозначает контекст, или обозначает контекст неподходящего типа -
ContextNotEmptyException- если указанный контекст не пустой -
NamingException- если возникло исключение при работе с именованием - См. также:
Context.destroySubcontext(String)
createSubcontext
public Context createSubcontext(String name)
throws NamingException Описание скопировано из интерфейса: Context
Создаёт и связывает новый контекст. См. Context.createSubcontext(Name) для подробностей.
- Определено в:
-
createSubcontextв интерфейсеContext - Параметры:
-
name- имя создаваемого контекста; не должно быть пустым - Возвращает:
- новый созданный контекст
- Исключения:
-
NameAlreadyBoundException- если имя уже связано -
InvalidAttributesException- если для создания подконтекста требуется указание обязательных атрибутов -
NamingException- если возникла ошибка при работе с именованием
createSubcontext
public Context createSubcontext(Name name)
throws NamingException Описание скопировано из интерфейса: Context
Создаёт и связывает новый контекст. Создаёт новый контекст с заданным именем и связывает его в целевом контексте (названном всеми, кроме конечного атомарного компонента имени). Все промежуточные контексты и целевой контекст должны уже существовать.
- Определено в:
-
createSubcontextв интерфейсеContext - Параметры:
-
name- имя создаваемого контекста; не должно быть пустым - Возвращает:
- новый созданный контекст
- Исключения:
-
NameAlreadyBoundException- если имя уже связано -
InvalidAttributesException- если для создания подконтекста требуется указание обязательных атрибутов -
NamingException- если возникла ошибка при работе с именованием - См. также:
-
Context.createSubcontext(String),DirContext.createSubcontext(javax.naming.Name, javax.naming.directory.Attributes)
lookupLink
public Object lookupLink(String name)
throws NamingException Описание скопировано из интерфейса: Context
Возвращает поисковый объект, следуя ссылкам, за исключением конечного атомарного компонента имени. См. Context.lookupLink(Name) для подробностей.
- Определено в:
-
lookupLinkв интерфейсеContext - Параметры:
-
name- имя искомого объекта - Возвращает:
- объект, связанный с
name, не следуя конечной ссылке (если она есть) - Исключения:
-
NamingException- если возникла ошибка при работе с именованием
lookupLink
public Object lookupLink(Name name)
throws NamingException Описание скопировано из интерфейса: Context
Возвращает поисковый объект, следуя ссылкам, за исключением конечного атомарного компонента имени. Если объект, связанный с name, не является ссылкой, возвращает сам объект.
- Определено в:
-
lookupLinkв интерфейсеContext - Параметры:
-
name- имя искомого объекта - Возвращает:
- объект, связанный с
name, не следуя конечной ссылке (если она есть). - Исключения:
-
NamingException- если возникла ошибка при работе с именованием - См. также:
Context.lookupLink(String)
getNameParser
public NameParser getNameParser(String name)
throws NamingException Описание скопировано из интерфейса: Context
Возвращает парсер, связанный с контекстом по имени. См. Context.getNameParser(Name) для подробностей.
- Определено в:
-
getNameParserв интерфейсеContext - Параметры:
-
name- имя контекста, для которого требуется получить парсер - Возвращает:
- парсер имён, который может анализировать составные имена до атомарных компонентов
- Исключения:
-
NamingException- если возникла ошибка при работе с именованием
getNameParser
public NameParser getNameParser(Name name)
throws NamingException Описание скопировано из интерфейса: Context
Возвращает парсер, связанный с контекстом по имени. В федерации пространств имён разные системы именования будут анализировать имена по-разному. Этот метод позволяет приложению получить парсер для анализа имён на атомарные компоненты с использованием соглашения об именах конкретной системы именования. В рамках любой одной системы именования объекты, возвращаемые этим методом, должны быть равны (с использованием теста equals()).
- Определено в:
-
getNameParserв интерфейсеContext - Параметры:
-
name- имя контекста, для которого требуется получить парсер - Возвращает:
- парсер имён, который может анализировать составные имена до атомарных компонентов
- Исключения:
-
NamingException- если возникла ошибка при работе с именованием - См. также:
-
Context.getNameParser(String),CompoundName
composeName
public String composeName(String name,
String prefix)
throws NamingException Объединяет имя этого контекста с именем, относящимся к этому контексту. Поскольку начальный контекст может никогда не быть назван относительно любого контекста, кроме себя, значение параметра prefix должно быть пустым именем ("").
- Определено в:
-
composeNameв интерфейсеContext - Параметры:
-
name- имя, относящееся к этому контексту -
prefix- имя этого контекста относительно одного из его предков - Возвращает:
- результат объединения
prefixиname - Исключения:
-
NamingException- если возникла ошибка при работе с именованием
composeName
public Name composeName(Name name,
Name prefix)
throws NamingException Объединяет имя этого контекста с именем, относящимся к этому контексту. Поскольку начальный контекст может никогда не быть назван относительно любого контекста, кроме себя, значение параметра prefix должно быть пустым именем.
- Определено в:
-
composeNameв интерфейсеContext - Параметры:
-
name- имя, относящееся к этому контексту -
prefix- имя этого контекста относительно одного из его предков - Возвращает:
- результат объединения
prefixиname - Исключения:
-
NamingException- если возникла ошибка при работе с именованием - См. также:
Context.composeName(String, String)
addToEnvironment
public Object addToEnvironment(String propName,
Object propVal)
throws NamingException Описание скопировано из интерфейса: Context
Добавляет новую средовую переменную в среду этого контекста. Если переменная уже существует, её значение перезаписывается. См. описание класса для получения более подробной информации об средовых переменных.
- Определено в:
-
addToEnvironmentв интерфейсеContext - Параметры:
-
propName- имя добавляемой средовой переменной; не должно быть null -
propVal- значение добавляемой переменной; не должно быть null - Возвращает:
- предыдущее значение переменной или null, если переменная ранее не была в среде
- Исключения:
-
NamingException- если возникла ошибка при работе с именованием - См. также:
-
Context.getEnvironment(),Context.removeFromEnvironment(String)
removeFromEnvironment
public Object removeFromEnvironment(String propName)
throws NamingException Описание скопировано из интерфейса: Context
Удаляет средовую переменную из среды этого контекста. См. описание класса для получения более подробной информации об средовых переменных.
- Определено в:
-
removeFromEnvironmentв интерфейсеContext - Параметры:
-
propName- имя удаляемой средовой переменной; не должно быть null - Возвращает:
- предыдущее значение переменной или null, если переменная не была в среде
- Исключения:
-
NamingException- если возникла ошибка при работе с именованием - См. также:
-
Context.getEnvironment(),Context.addToEnvironment(String, Object)
getEnvironment
public Hashtable<?,?> getEnvironment()
throws NamingException Описание скопировано из интерфейса: Context
Возвращает среду, действующую для этого контекста. См. описание класса для получения более подробной информации об средовых переменных.
Вызывающий метод не должен вносить изменений в возвращаемый объект: их влияние на контекст не определено. Среду этого контекста можно изменить с помощью addToEnvironment() и removeFromEnvironment().
- Определено в:
-
getEnvironmentв интерфейсеContext - Возвращает:
- среду этого контекста; никогда не null
- Исключения:
-
NamingException- если возникла ошибка при работе с именованием - См. также:
-
Context.addToEnvironment(String, Object),Context.removeFromEnvironment(String)
close
public void close()
throws NamingException Описание скопировано из интерфейса: Context
Закрывает этот контекст. Этот метод сразу освобождает ресурсы этого контекста, вместо ожидания их автоматического освобождения сборщиком мусора.
Этот метод идемпотентен: вызов его для контекста, который уже закрыт, не имеет эффекта. Вызов любого другого метода для закрытого контекста запрещён и приводит к неопределённому поведению.
- Определено в:
-
closeв интерфейсеContext - Исключения:
-
NamingException- если возникла ошибка при работе с именованием
getNameInNamespace
public String getNameInNamespace()
throws NamingException Описание скопировано из интерфейса: Context
Возвращает полное имя этого контекста в пределах собственного пространства имён.
Многие службы именования имеют понятие «полного имени» для объектов в их соответствующих пространствах имён. Например, запись LDAP имеет выделенное имя, а запись DNS имеет полностью квалифицированное имя. Этот метод позволяет клиентскому приложению получить это имя. Строка, возвращённая этим методом, не является составным именем JNDI и не должна передаваться напрямую методам контекста. В системах именования, для которых понятие полного имени не имеет смысла, выбрасывается OperationNotSupportedException.
- Определено в:
-
getNameInNamespaceв интерфейсеContext - Возвращает:
- имя контекста в собственном пространстве имён; никогда не null
- Исключения:
-
OperationNotSupportedException- если система именования не имеет понятия полного имени -
NamingException- если возникла ошибка при работе с именованием
© 1993, 2020, 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.