Spec-Zone.ru › OpenJDK 8

Класс InitialDirContext

  • java.lang.Object
    • javax.naming.InitialContext
      • javax.naming.directory.InitialDirContext
Все реализованные интерфейсы:
Context, DirContext
Прямые известные подклассы:
InitialLdapContext

public class InitialDirContext
extends InitialContext
implements DirContext

Этот класс является контекстом запуска для выполнения операций с каталогом. Документация в описании класса InitialContext (включая синхронизацию) применима и здесь.

С:
1.3
См. также:
InitialContext

Поля

Поля, унаследованные от класса javax.naming.InitialContext

defaultInitCtx, gotDefault, myProps

Поля, унаследованные от интерфейса javax.naming.directory.DirContext

ADD_ATTRIBUTE, REMOVE_ATTRIBUTE, REPLACE_ATTRIBUTE

Поля, унаследованные от интерфейса 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

Конструкторы

Модификатор Конструктор и описание
InitialDirContext()

Создаёт начальный DirContext.
protected InitialDirContext(boolean lazy)

Создаёт начальный DirContext с возможностью не инициализировать его.
InitialDirContext(Hashtable<?,?> environment)

Создаёт начальный DirContext, используя предоставленную среду.

Методы

Модификатор и тип Метод и описание
void bind(Name name, Object obj, Attributes attrs)

Связывает имя с объектом вместе с ассоциированными атрибутами.
void bind(String name, Object obj, Attributes attrs)

Связывает имя с объектом вместе с ассоциированными атрибутами.
DirContext createSubcontext(Name name, Attributes attrs)

Создаёт и связывает новый контекст вместе с ассоциированными атрибутами.
DirContext createSubcontext(String name, Attributes attrs)

Создаёт и связывает новый контекст вместе с ассоциированными атрибутами.
Attributes getAttributes(Name name)

Получает все атрибуты, связанные с объектом по имени.
Attributes getAttributes(Name name, String[] attrIds)

Получает выбранные атрибуты, связанные с объектом по имени.
Attributes getAttributes(String name)

Получает все атрибуты, связанные с объектом по имени.
Attributes getAttributes(String name, String[] attrIds)

Получает выбранные атрибуты, связанные с объектом по имени.
DirContext getSchema(Name name)

Получает схему, связанную с объектом по имени.
DirContext getSchema(String name)

Получает схему, связанную с объектом по имени.
DirContext getSchemaClassDefinition(Name name)

Получает контекст, содержащий объекты схемы определений классов указанного объекта.
DirContext getSchemaClassDefinition(String name)

Получает контекст, содержащий объекты схемы определений классов указанного объекта.
void modifyAttributes(Name name, int mod_op, Attributes attrs)

Изменяет атрибуты, связанные с объектом по имени.
void modifyAttributes(Name name, ModificationItem[] mods)

Изменяет атрибуты, связанные с объектом по имени, используя упорядоченный список изменений.
void modifyAttributes(String name, int mod_op, Attributes attrs)

Изменяет атрибуты, связанные с объектом по имени.
void modifyAttributes(String name, ModificationItem[] mods)

Изменяет атрибуты, связанные с объектом по имени, используя упорядоченный список изменений.
void rebind(Name name, Object obj, Attributes attrs)

Связывает имя с объектом, а также сопутствующие атрибуты, перезаписывая любое существующее связывание.
void rebind(String name, Object obj, Attributes attrs)

Связывает имя с объектом вместе с ассоциированными атрибутами, перезаписывая любое существующее связывание.
NamingEnumeration<SearchResult> search(Name name, Attributes matchingAttributes)

Ищет в одном контексте объекты, содержащие указанный набор атрибутов.
NamingEnumeration<SearchResult> search(Name name, Attributes matchingAttributes, String[] attributesToReturn)

Ищет в одном контексте объекты, содержащие указанный набор атрибутов, и извлекает выбранные атрибуты.
NamingEnumeration<SearchResult> search(Name name, String filterExpr, Object[] filterArgs, SearchControls cons)

Ищет в указанном контексте или объекте записи, удовлетворяющие заданному фильтру поиска.
NamingEnumeration<SearchResult> search(Name name, String filter, SearchControls cons)

Ищет в указанном контексте или объекте записи, удовлетворяющие заданному фильтру поиска.
NamingEnumeration<SearchResult> search(String name, Attributes matchingAttributes)

Ищет в одном контексте объекты, содержащие указанный набор атрибутов.
NamingEnumeration<SearchResult> search(String name, Attributes matchingAttributes, String[] attributesToReturn)

Ищет в одном контексте объекты, содержащие указанный набор атрибутов, и извлекает выбранные атрибуты.
NamingEnumeration<SearchResult> search(String name, String filterExpr, Object[] filterArgs, SearchControls cons)

Ищет в указанном контексте или объекте записи, удовлетворяющие заданному фильтру поиска.
NamingEnumeration<SearchResult> search(String name, String filter, SearchControls cons)

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

Методы, унаследованные от класса javax.naming.InitialContext

addToEnvironment, bind, bind, close, composeName, composeName, createSubcontext, createSubcontext, destroySubcontext, destroySubcontext, doLookup, doLookup, getDefaultInitCtx, getEnvironment, getNameInNamespace, getNameParser, getNameParser, getURLOrDefaultInitCtx, getURLOrDefaultInitCtx, init, list, list, listBindings, listBindings, lookup, lookup, lookupLink, lookupLink, rebind, rebind, removeFromEnvironment, rename, rename, unbind, unbind

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

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

Методы, унаследованные от интерфейса javax.naming.Context

addToEnvironment, bind, bind, close, composeName, composeName, createSubcontext, createSubcontext, destroySubcontext, destroySubcontext, getEnvironment, getNameInNamespace, getNameParser, getNameParser, list, list, listBindings, listBindings, lookup, lookup, lookupLink, lookupLink, rebind, rebind, removeFromEnvironment, rename, rename, unbind, unbind

Конструкторы

InitialDirContext

protected InitialDirContext(boolean lazy)
                     throws NamingException

Создаёт начальный DirContext с опцией не инициализировать его. Это может использоваться конструктором подкласса, когда значение параметра среды ещё неизвестно в момент вызова конструктора InitialDirContext. Конструктор подкласса вызовет этот конструктор, вычислит значение среды, а затем вызовет init() перед возвратом.

Параметры:
lazy - true означает, что начальный DirContext не нужно инициализировать; false эквивалентно вызову new InitialDirContext()
Исключения:
NamingException - если возникло исключение именования
С тех пор:
1.3
См. также:
InitialContext.init(Hashtable)

InitialDirContext

public InitialDirContext()
                  throws NamingException

Создаёт начальный DirContext. Свойства среды не предоставляются. Эквивалентно new InitialDirContext(null).

Исключения:
NamingException - если возникло исключение именования
См. также:
InitialDirContext(Hashtable)

InitialDirContext

public InitialDirContext(Hashtable<?,?> environment)
                  throws NamingException

Создаёт начальный DirContext, используя предоставленную среду. Свойства среды обсуждаются в описании класса javax.naming.InitialContext.

Этот конструктор не будет изменять environment или сохранять ссылку на него, но может сохранить копию. Вызывающий метод не должен изменять изменяемые ключи и значения в environment после того, как они были переданы в конструктор.

Параметры:
environment - среда, используемая для создания начального DirContext. Null указывает пустую среду.
Исключения:
NamingException - если возникло исключение именования

Методы

getAttributes

public Attributes getAttributes(String name)
                         throws NamingException

Описание скопировано из интерфейса: DirContext

Получает все атрибуты, связанные с именованным объектом. Подробнее см. DirContext.getAttributes(Name).

Определено в:
getAttributes в интерфейсе DirContext
Параметры:
name - имя объекта, атрибуты которого нужно получить
Возвращает:
множество атрибутов, связанных с name
Исключения:
NamingException - если возникло исключение именования

getAttributes

public Attributes getAttributes(String name,
                                String[] attrIds)
                         throws NamingException

Описание скопировано из интерфейса: DirContext

Возвращает выбранные атрибуты, связанные с объектом по имени. Подробнее см. DirContext.getAttributes(Name, String[]).

Определено в:
getAttributes в интерфейсе DirContext
Параметры:
name - имя объекта, из которого нужно получить атрибуты
attrIds - идентификаторы атрибутов для получения. null означает, что нужно получить все атрибуты; пустой массив означает, что не нужно получать никаких атрибутов.
Возвращает:
запрошенные атрибуты; никогда не null
Исключение:
NamingException - если возникло исключение при работе с именованием

getAttributes

public Attributes getAttributes(Name name)
                         throws NamingException

Описание скопировано из интерфейса: DirContext

Возвращает все атрибуты, связанные с объектом по имени. Подробнее об моделях атрибутов, именах типов атрибутов и операционных атрибутах см. описание класса.

Определено в:
getAttributes в интерфейсе DirContext
Параметры:
name - имя объекта, из которого нужно получить атрибуты
Возвращает:
набор атрибутов, связанных с name. Возвращает пустой набор атрибутов, если у объекта нет атрибутов; никогда не null.
Исключение:
NamingException - если возникло исключение при работе с именованием
См. также:
DirContext.getAttributes(String), DirContext.getAttributes(Name, String[])

getAttributes

public Attributes getAttributes(Name name,
                                String[] attrIds)
                         throws NamingException

Описание скопировано из интерфейса: DirContext

Возвращает выбранные атрибуты, связанные с объектом по имени. Подробнее об моделях атрибутов, именах типов атрибутов и операционных атрибутах см. описание класса.

Если у объекта нет указанного атрибута, каталог проигнорирует несуществующий атрибут и вернет те запрошенные атрибуты, которые у объекта есть.

Каталог может вернуть больше атрибутов, чем было запрошено (см. Имена типов атрибутов в описании класса), но не должен возвращать произвольные, не связанные атрибуты.

См. также Операционные атрибуты в описании класса.

Указано в:
getAttributes в интерфейсе DirContext
Параметры:
name - имя объекта, из которого необходимо извлечь атрибуты
attrIds - идентификаторы атрибутов для извлечения. null означает, что должны быть извлечены все атрибуты; пустой массив означает, что не нужно извлекать ни одного.
Возвращает:
запрошенные атрибуты; никогда не null
Исключения:
NamingException - если возникло исключение при именовании

modifyAttributes

public void modifyAttributes(String name,
                             int mod_op,
                             Attributes attrs)
                      throws NamingException

Описание скопировано из интерфейса: DirContext

Изменяет атрибуты, связанные с именованным объектом. Смотрите DirContext.modifyAttributes(Name, int, Attributes) для подробностей.

Указано в:
modifyAttributes в интерфейсе DirContext
Параметры:
name - имя объекта, атрибуты которого будут обновлены
mod_op - операция модификации, одна из: ADD_ATTRIBUTE, REPLACE_ATTRIBUTE, REMOVE_ATTRIBUTE.
attrs - атрибуты, используемые для модификации; не может быть null
Исключения:
AttributeModificationException - если модификация не может быть выполнена успешно
NamingException - если возникло исключение при именовании

modifyAttributes

public void modifyAttributes(Name name,
                             int mod_op,
                             Attributes attrs)
                      throws NamingException

Описание скопировано из интерфейса: DirContext

Изменяет атрибуты, связанные с именованным объектом. Порядок модификаций не определён. В случае возможности, модификации выполняются атомарно.

Указано в:
modifyAttributes в интерфейсе DirContext
Параметры:
name - имя объекта, атрибуты которого будут обновлены
mod_op - операция модификации, одна из: ADD_ATTRIBUTE, REPLACE_ATTRIBUTE, REMOVE_ATTRIBUTE.
attrs - атрибуты, используемые для модификации; не может быть null
Исключения:
AttributeModificationException - если модификация не может быть выполнена успешно
NamingException - если возникло исключение при именовании
См. также:
DirContext.modifyAttributes(Name, ModificationItem[])

modifyAttributes

public void modifyAttributes(String name,
                             ModificationItem[] mods)
                      throws NamingException

Описание скопировано из интерфейса: DirContext

Изменяет атрибуты, связанные с именованным объектом, используя упорядоченный список изменений. Подробнее см. DirContext.modifyAttributes(Name, ModificationItem[]).

Определено в:
modifyAttributes в интерфейсе DirContext
Параметры:
name - имя объекта, атрибуты которого будут обновлены
mods - упорядоченная последовательность выполняемых изменений; не может быть null
Исключения:
AttributeModificationException - если изменения не могут быть успешно выполнены
NamingException - если возникло исключение именования

modifyAttributes

public void modifyAttributes(Name name,
                             ModificationItem[] mods)
                      throws NamingException

Описание скопировано из интерфейса: DirContext

Изменяет атрибуты, связанные с именованным объектом, используя упорядоченный список изменений. Изменения выполняются в указанном порядке. Каждое изменение определяет код операции изменения и атрибут, над которым нужно действовать. По возможности изменения выполняются атомарно.

Определено в:
modifyAttributes в интерфейсе DirContext
Параметры:
name - имя объекта, атрибуты которого будут обновлены
mods - упорядоченная последовательность выполняемых изменений; не может быть null
Исключения:
AttributeModificationException - если изменения не могут быть успешно выполнены
NamingException - если возникло исключение именования
См. также:
DirContext.modifyAttributes(Name, int, Attributes), ModificationItem

bind

public void bind(String name,
                 Object obj,
                 Attributes attrs)
          throws NamingException

Описание скопировано из интерфейса: DirContext

Связывает имя с объектом вместе с ассоциированными атрибутами. Подробнее см. DirContext.bind(Name, Object, Attributes).

Указано:
bind в интерфейсе DirContext
Параметры:
name - имя для привязки; не должно быть пустым
obj - объект для привязки; возможно null
attrs - атрибуты для ассоциации с привязкой
Исключения:
NameAlreadyBoundException - если имя уже привязано
InvalidAttributesException - если некоторые «обязательные» атрибуты привязки не заданы
NamingException - если возникло исключение при именовании

bind

public void bind(Name name,
                 Object obj,
                 Attributes attrs)
          throws NamingException

Описание скопировано из интерфейса: DirContext

Привязывает имя к объекту вместе с ассоциированными атрибутами. Если attrs равно null, результирующая привязка будет иметь атрибуты, связанные с obj , если obj является DirContext, и без атрибутов в противном случае. Если attrs не равно null, результирующая привязка будет иметь attrs в качестве своих атрибутов; любые атрибуты, связанные с obj , игнорируются.

Указано:
bind в интерфейсе DirContext
Параметры:
name - имя для привязки; не должно быть пустым
obj - объект для привязки; возможно null
attrs - атрибуты для ассоциации с привязкой
Исключения:
NameAlreadyBoundException - если имя уже привязано
InvalidAttributesException - если некоторые «обязательные» атрибуты привязки не заданы
NamingException - если возникло исключение при именовании
См. также:
Context.bind(Name, Object), DirContext.rebind(Name, Object, Attributes)

rebind

public void rebind(String name,
                   Object obj,
                   Attributes attrs)
            throws NamingException

Описание скопировано из интерфейса: DirContext

Привязывает имя к объекту вместе с ассоциированными атрибутами, перезаписывая любую существующую привязку. Подробности см. в DirContext.rebind(Name, Object, Attributes).

Указано в:
rebind в интерфейсе DirContext
Параметры:
name - имя для привязки; не может быть пустым
obj - объект для привязки; может быть null
attrs - атрибуты для ассоциации с привязкой
Исключения:
InvalidAttributesException - если некоторые «обязательные» атрибуты привязки не предоставлены
NamingException - если возникло исключение при именовании

rebind

public void rebind(Name name,
                   Object obj,
                   Attributes attrs)
            throws NamingException

Описание скопировано из интерфейса: DirContext

Привязывает имя к объекту вместе с ассоциированными атрибутами, перезаписывая любую существующую привязку. Если attrs равно null и obj является DirContext, атрибуты из obj используются. Если attrs равно null и obj не является DirContext, любые существующие атрибуты, связанные с объектом, уже привязанным в каталоге, остаются неизменными. Если attrs не null, любые существующие атрибуты, связанные с объектом, уже привязанным в каталоге, удаляются, и attrs ассоциируется с именованным объектом. Если obj является DirContext и attrs не null, атрибуты obj игнорируются.

Указано в:
rebind в интерфейсе DirContext
Параметры:
name - имя для привязки; не может быть пустым
obj - объект для привязки; может быть null
attrs - атрибуты для ассоциации с привязкой
Исключения:
InvalidAttributesException - если некоторые «обязательные» атрибуты привязки не предоставлены
NamingException - если возникло исключение при именовании
См. также:
Context.bind(Name, Object), DirContext.bind(Name, Object, Attributes)

createSubcontext

public DirContext createSubcontext(String name,
                                   Attributes attrs)
                            throws NamingException

Описание скопировано из интерфейса: DirContext

Создает и привязывает новый контекст вместе с ассоциированными атрибутами. Подробности см. в DirContext.createSubcontext(Name, Attributes).

Определено в:
createSubcontext в интерфейсе DirContext
Параметры:
name - имя контекста для создания; не должно быть пустым
attrs - атрибуты, которые нужно связать с вновь созданным контекстом
Возвращает:
новый созданный контекст
Исключения:
NameAlreadyBoundException - если имя уже связано
InvalidAttributesException - если attrs не содержит все обязательные атрибуты, необходимые для создания
NamingException - если возникло исключение при именовании

createSubcontext

public DirContext createSubcontext(Name name,
                                   Attributes attrs)
                            throws NamingException

Описание скопировано из интерфейса: DirContext

Создаёт и связывает новый контекст вместе с связанными атрибутами. Этот метод создаёт новый подконтекст с заданным именем, связывает его в целевом контексте (определённом всеми, кроме конечного атомного компонента имени) и связывает предоставленные атрибуты с вновь созданным объектом. Все промежуточные и целевые контексты должны уже существовать. Если attrs равно null, этот метод эквивалентен Context.createSubcontext().

Определено в:
createSubcontext в интерфейсе DirContext
Параметры:
name - имя контекста для создания; не должно быть пустым
attrs - атрибуты, которые нужно связать с вновь созданным контекстом
Возвращает:
новый созданный контекст
Исключения:
NameAlreadyBoundException - если имя уже связано
InvalidAttributesException - если attrs не содержит все обязательные атрибуты, необходимые для создания
NamingException - если возникло исключение при именовании
См. также:
Context.createSubcontext(Name)

getSchema

public DirContext getSchema(String name)
                     throws NamingException

Описание скопировано из интерфейса: DirContext

Получает схему, связанную с именованным объектом. Подробнее см. DirContext.getSchema(Name).

Определено в:
getSchema в интерфейсе DirContext
Параметры:
name - имя объекта, схему которого нужно получить
Возвращает:
схема, связанная с контекстом; никогда не null
Исключения:
OperationNotSupportedException - если схема не поддерживается
NamingException - если возникло исключение при именовании

getSchema

public DirContext getSchema(Name name)
                     throws NamingException

Описание скопировано из интерфейса: DirContext

Возвращает схему, связанную с указанным объектом. Схема описывает правила, касающиеся структуры пространства имен и атрибутов, хранящихся в нем. Схема определяет, какие типы объектов могут быть добавлены в каталог и куда, какие обязательные и необязательные атрибуты может иметь объект. Диапазон поддержки схем зависит от конкретного каталога.

Этот метод возвращает корень дерева информации схемы, применимой к указанному объекту. Несколько указанных объектов (или даже весь каталог) могут использовать одну и ту же схему.

Вопросы, связанные со структурой и содержимым дерева схемы, разрешением на изменение содержимого дерева схемы и влиянием таких изменений на каталог зависят от базового каталога.

Определено в:
getSchema в интерфейсе DirContext
Параметры:
name - имя объекта, схема которого должна быть получена
Возвращает:
схему, связанную с контекстом; никогда не null
Исключения:
OperationNotSupportedException - если схема не поддерживается
NamingException - если возникло исключение именования

getSchemaClassDefinition

public DirContext getSchemaClassDefinition(String name)
                                    throws NamingException

Описание скопировано из интерфейса: DirContext

Возвращает контекст, содержащий объекты схемы определений классов указанного объекта. Подробности см. в DirContext.getSchemaClassDefinition(Name).

Определено в:
getSchemaClassDefinition в интерфейсе DirContext
Параметры:
name - имя объекта, определение класса которого должно быть получено
Возвращает:
контекст DirContext, содержащий определения классов указанного объекта; никогда не null
Исключения:
OperationNotSupportedException - если схема не поддерживается
NamingException - если возникло исключение именования

getSchemaClassDefinition

public DirContext getSchemaClassDefinition(Name name)
                                    throws NamingException

Описание скопировано из интерфейса: DirContext

Получает контекст, содержащий объекты схемы определений классов указанного объекта.

Одним из категорий информации в схемах каталога являются определения классов. Определение "класса объекта" указывает тип объекта и какие атрибуты (обязательные и необязательные) объект должен/может иметь. Обратите внимание, что термин "класс объекта", к которому здесь относится, относится к каталогу, а не к Java. Например, если указанный объект — это объект каталога класса "Person", getSchemaClassDefinition() вернёт DirContext, представляющий определение класса объекта (каталога) "Person".

Информация, которая может быть извлечена из определения класса объекта, зависит от каталога.

До JNDI 1.2 этот метод возвращал единственный объект схемы, представляющий определение класса указанного объекта. С JNDI 1.2 этот метод возвращает DirContext, содержащий все определения классов указанного объекта.

Определено в:
getSchemaClassDefinition в интерфейсе DirContext
Параметры:
name — имя объекта, определение класса объекта которого необходимо получить
Возвращает:
контейнер DirContext, содержащий определения классов указанного объекта; никогда не null
Исключения:
OperationNotSupportedException — если схема не поддерживается
NamingException — если возникло исключение именования

search

public NamingEnumeration<SearchResult> search(String name,
                                              Attributes matchingAttributes)
                                       throws NamingException

Описание скопировано из интерфейса: DirContext

Ищет в одном контексте объекты, содержащие указанный набор атрибутов. Смотрите DirContext.search(Name, Attributes) для получения подробностей.

Определено в:
search в интерфейсе DirContext
Параметры:
name — имя контекста для поиска
matchingAttributes — атрибуты для поиска
Возвращает:
перечисление SearchResult объектов
Исключения:
NamingException — если возникло исключение именования

search

public NamingEnumeration<SearchResult> search(Name name,
                                              Attributes matchingAttributes)
                                       throws NamingException

Описание скопировано из интерфейса: DirContext

Ищет в одном контексте объекты, содержащие указанный набор атрибутов. Этот метод возвращает все атрибуты таких объектов. Он эквивалентен передаче null в качестве параметра atributesToReturn методу search(Name, Attributes, String[]).
См. DirContext.search(Name, Attributes, String[]) для полного описания.

Определено в:
search в интерфейсе DirContext
Параметры:
name - имя контекста для поиска
matchingAttributes - атрибуты для поиска
Возвращает:
перечисление объектов SearchResult
Исключения:
NamingException - если возникает исключение именования
См. также:
DirContext.search(Name, Attributes, String[])

search

public NamingEnumeration<SearchResult> search(String name,
                                              Attributes matchingAttributes,
                                              String[] attributesToReturn)
                                       throws NamingException

Описание скопировано из интерфейса: DirContext

Ищет в одном контексте объекты, содержащие указанный набор атрибутов, и извлекает выбранные атрибуты. См. DirContext.search(Name, Attributes, String[]) для получения подробностей.

Определено в:
search в интерфейсе DirContext
Параметры:
name - имя контекста для поиска
matchingAttributes - атрибуты для поиска
attributesToReturn - атрибуты для возврата
Возвращает:
непустое перечисление объектов SearchResult
Исключения:
NamingException - если возникает исключение именования

search

public NamingEnumeration<SearchResult> search(Name name,
                                              Attributes matchingAttributes,
                                              String[] attributesToReturn)
                                       throws NamingException

Описание скопировано из интерфейса: DirContext

Поиск в одном контексте объектов, содержащих заданный набор атрибутов, и извлечение выбранных атрибутов. Поиск выполняется с использованием стандартных SearchControls настроек.

Для того, чтобы объект был выбран, каждый атрибут в matchingAttributes должен совпадать с каким-либо атрибутом объекта. Если matchingAttributes пусто или равно null, возвращаются все объекты в целевом контексте.

Атрибут A1 в matchingAttributes считается соответствующим атрибуту A2 объекта, если A1 и A2 имеют одинаковый идентификатор, и каждое значение A1 равно какому-либо значению A2. Это подразумевает, что порядок значений не имеет значения, и что A2 может содержать "дополнительные" значения, отсутствующие в A1, без влияния на сравнение. Это также подразумевает, что если A1 не имеет значений, то проверка на соответствие эквивалентна проверке наличия атрибута A2 с тем же идентификатором.

Точное определение "равенства", используемое при сравнении значений атрибутов, определяется базовой службой каталогов. Она может использовать метод Object.equals, например, или может использовать схему для задания другой операции равенства. Для сопоставления, основанного на операциях, отличных от равенства (например, сравнение подстрок), используйте версию метода search, которая принимает аргумент фильтра.

Когда вносится изменение в этот DirContext, эффект на перечисления, возвращаемые предыдущими вызовами этого метода, не определен.

Если у объекта отсутствует указанный атрибут, каталог проигнорирует несуществующий атрибут и вернёт запрошенные атрибуты, которые у объекта есть.

Каталог может вернуть больше атрибутов, чем было запрошено (см. Имена типов атрибутов в описании класса), но не имеет права возвращать произвольные, не связанные атрибуты.

См. также Операционные атрибуты в описании класса.

Указано в:
search в интерфейсе DirContext
Параметры:
name - имя контекста для поиска
matchingAttributes - атрибуты для поиска. Если пусто или null, возвращаются все объекты в целевом контексте.
attributesToReturn - атрибуты для возврата. null указывает, что должны быть возвращены все атрибуты; пустой массив указывает, что не нужно возвращать никаких.
Возвращает:
непустой перечисление объектов SearchResult. Каждый объект SearchResult содержит атрибуты, определенные attributesToReturn, и имя соответствующего объекта, указанного относительно контекста, названного name.
Выбрасывает:
NamingException - если возникает исключение именования
См. также:
SearchControls, SearchResult, DirContext.search(Name, String, Object[], SearchControls)

search

public NamingEnumeration<SearchResult> search(String name,
                                              String filter,
                                              SearchControls cons)
                                       throws NamingException

Описание скопировано из интерфейса: DirContext

Ищет в именованном контексте или объекте записи, удовлетворяющие заданному фильтру поиска. Выполняет поиск в соответствии с параметрами поиска. Подробнее см. DirContext.search(Name, String, SearchControls).

Указано в:
search в интерфейсе DirContext
Параметры:
name - имя контекста или объекта для поиска
filter - выражение фильтра поиска; не может быть null
cons - параметры поиска, которые управляют поиском. Если null, используются стандартные параметры поиска (эквивалентно (new SearchControls())).
Возвращает:
перечисление SearchResult для объектов, удовлетворяющих фильтру.
Выбрасывает:
InvalidSearchFilterException - если заданный фильтр поиска не поддерживается или не понят подлежащим каталогом
InvalidSearchControlsException - если параметры поиска содержат недопустимые настройки
NamingException - если возникает исключение именования

search

public NamingEnumeration<SearchResult> search(Name name,
                                              String filter,
                                              SearchControls cons)
                                       throws NamingException

Описание скопировано из интерфейса: DirContext

Ищет в заданном контексте или объекте записи, удовлетворяющие заданному фильтру поиска. Выполняет поиск в соответствии с настройками поиска.

Формат и интерпретация filter следуют RFC 2254 с последующими интерпретациями для attr и value, упомянутыми в RFC.

attr — идентификатор атрибута.

value — строковое представление значения атрибута. Перевод этого строкового представления в значение атрибута зависит от каталога.

Например, для утверждения "someCount=127", attr — это "someCount", а value — "127". Поставщик, исходя из идентификатора атрибута ("someCount") (и, возможно, его схемы), определяет, что значение атрибута является целым числом. Затем он корректно анализирует строку "127".

Любые символы с кодами больше ASCII в строке фильтра должны быть представлены соответствующими символами Java (Unicode), а не кодированы как октеты UTF-8. В качестве альтернативы можно использовать обозначение "обратный слэш-шестнадцатеричный код", описанное в RFC 2254.

Если каталог не поддерживает строковое представление некоторых или всех своих атрибутов, можно использовать форму search, которая принимает аргументы фильтра в виде объектов. Тогда поставщик сервиса такого каталога переведёт аргументы фильтра в свою специфичную для сервиса форму представления для оценки фильтра. См. search(Name, String, Object[], SearchControls).

RFC 2254 определяет некоторые операторы для фильтра, включая соответствие подстрокам, равенство, приблизительное соответствие, больше, меньше. Эти операторы отображаются на операторы с соответствующей семантикой в базовом каталоге. Например, для оператора равенства предположим, что каталог имеет правило сопоставления, определяющее "равенство" атрибутов в фильтре. Это правило будет использоваться для проверки равенства атрибутов, указанных в фильтре, с атрибутами объектов в каталоге. Аналогично, если каталог имеет правило сопоставления для упорядочения, это правило будет использоваться для сравнения "больше" и "меньше".

Не все операторы, определенные в RFC 2254, применимы ко всем атрибутам. Если оператор неприменим, выбрасывается исключение InvalidSearchFilterException.

Результат возвращается в перечислении SearchResults. Каждое SearchResult содержит имя объекта и другую информацию об объекте (см. SearchResult). Имя является либо относительным к целевому контексту поиска (который задается параметром name), либо строкой URL. Если целевой контекст включен в перечисление (как это возможно, когда cons указывает область поиска SearchControls.OBJECT_SCOPE или SearchControls.SUBSTREE_SCOPE), его имя — пустая строка. SearchResult также может содержать атрибуты соответствующего объекта, если аргумент cons указал, что атрибуты должны быть возвращены.

Если объект не имеет запрошенного атрибута, этот несуществующий атрибут будет проигнорирован. Запрошенные атрибуты, которые у объекта есть, будут возвращены.

Каталог может вернуть больше атрибутов, чем было запрошено (см. Имена типов атрибутов в описании класса), но не разрешается возвращать произвольные, не связанные атрибуты.

См. также Операционные атрибуты в описании класса.

Определено в:
search в интерфейсе DirContext
Параметры:
name - имя контекста или объекта для поиска
filter - выражение фильтра для использования в поиске; не может быть null
cons - параметры поиска, контролирующие поиск. Если null, используются параметры по умолчанию (эквивалентно (new SearchControls()))
Возвращает:
перечисление SearchResult объектов, удовлетворяющих фильтру; никогда не null
Исключения:
InvalidSearchFilterException - если заданный фильтр поиска не поддерживается или не понят базовым каталогом
InvalidSearchControlsException - если параметры поиска содержат недопустимые настройки
NamingException - если возникает исключение именования
См. также:
DirContext.search(Name, String, Object[], SearchControls), SearchControls, SearchResult

search

public NamingEnumeration<SearchResult> search(String name,
                                              String filterExpr,
                                              Object[] filterArgs,
                                              SearchControls cons)
                                       throws NamingException

Описание скопировано из интерфейса: DirContext

Ищет в заданном контексте или объекте записи, удовлетворяющие заданному фильтру поиска. Выполняет поиск в соответствии с заданными параметрами поиска. Подробнее см. DirContext.search(Name, String, Object[], SearchControls).

Указывается:
search в интерфейсе DirContext
Параметры:
name - имя контекста или объекта для поиска
filterExpr - выражение фильтра для поиска. Выражение может содержать переменные вида "{i}", где i - неотрицательное целое число. Не может быть null.
filterArgs - массив аргументов для подстановки в переменные в filterExpr. Значение filterArgs[i] будет заменять каждое вхождение "{i}". Если null, эквивалентно пустому массиву.
cons - параметры поиска, управляющие поиском. Если null, используются значения по умолчанию (эквивалентно (new SearchControls())).
Возвращает:
перечисление SearchResult объектов, удовлетворяющих фильтру; никогда не null
Исключения:
InvalidSearchControlsException - если cons содержит некорректные настройки
InvalidSearchFilterException - если filterExpr с filterArgs представляет недопустимый фильтр поиска
NamingException - если возникло исключение при работе с именами

поиск

public NamingEnumeration<SearchResult> search(Name name,
                                              String filterExpr,
                                              Object[] filterArgs,
                                              SearchControls cons)
                                       throws NamingException

Описание скопировано из интерфейса: DirContext

Ищет в указанном контексте или объекте записи, удовлетворяющие заданному фильтру поиска. Выполняет поиск в соответствии с заданными параметрами поиска.

Интерпретация filterExpr основана на RFC 2254. Она может дополнительно содержать переменные вида {i} — где i — целое число — которые ссылаются на объекты в массиве filterArgs. Интерпретация filterExpr в остальном идентична интерпретации параметра filter метода search(Name, String, SearchControls).

Когда в фильтре поиска появляется переменная {i}, это означает, что в этом месте должен использоваться аргумент фильтра filterArgs[i]. Такие переменные могут использоваться везде, где в грамматике фильтра RFC 2254, раздел 4, встречаются конструкции attr, value или matchingrule. При подстановке строкового аргумента фильтра вместо переменной фильтр интерпретируется так, как если бы строка была указана вместо переменной, а любые символы, имеющие специальное значение в фильтрах (такие как '*'), были экранированы в соответствии с правилами RFC 2254.

Для каталогов, которые не используют строковое представление для некоторых или всех своих атрибутов, аргумент фильтра, соответствующий значению атрибута, может быть типа, отличного от String. Например, каталоги, поддерживающие несфомированные атрибуты со значениями в двоичном формате, должны принимать массивы байтов в качестве аргументов фильтра. Интерпретация (если она есть) аргументов фильтра любого другого типа определяется поставщиком сервиса для этого каталога, который отображает операции фильтрации на операции с соответствующей семантикой в базовом каталоге.

Этот метод возвращает перечисление результатов. Каждый элемент перечисления содержит имя объекта и другую информацию об объекте (см. SearchResult). Имя является либо относительным к целевому контексту поиска (названному параметром name), либо строкой URL. Если целевой контекст включён в перечисление (что возможно, когда cons задаёт область поиска SearchControls.OBJECT_SCOPE или SearchControls.SUBSTREE_SCOPE), его имя является пустой строкой.

SearchResult также может содержать атрибуты соответствующего объекта, если аргумент cons указывает на необходимость возвращения атрибутов.

Если у объекта отсутствует запрашиваемый атрибут, этот несуществующий атрибут будет проигнорирован. Запрашиваемые атрибуты, которые у объекта есть, будут возвращены.

Каталог может вернуть больше атрибутов, чем было запрошено (см. Имена типов атрибутов в описании класса), но не имеет права возвращать произвольные, не связанные атрибуты.

Если в этот метод передается фильтр поиска с недопустимыми подстановками переменных, результат не определен. При внесении изменений в этот DirContext, влияние на перечисления, возвращаемые предыдущими вызовами этого метода, не определено.

См. также Операционные атрибуты в описании класса.

Указано в:
search в интерфейсе DirContext
Параметры:
name - имя контекста или объекта для поиска
filterExpr - выражение фильтра для поиска. Выражение может содержать переменные вида "{i}", где i — неотрицательное целое число. Не может быть null.
filterArgs - массив аргументов для подстановки переменных в filterExpr. Значение filterArgs[i] будет заменять каждое вхождение "{i}". Если null, эквивалентно пустому массиву.
cons - параметры поиска, которые контролируют поиск. Если null, используются стандартные параметры поиска (эквивалентно (new SearchControls())).
Возвращает:
перечисление SearchResult объектов, удовлетворяющих фильтру; никогда не null
Исключение:
InvalidSearchControlsException - если cons содержит недопустимые настройки
InvalidSearchFilterException - если filterExpr с filterArgs представляет недопустимый фильтр поиска
NamingException - если возникает исключение именования
См. также:
DirContext.search(Name, Attributes, String[]), MessageFormat

© 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.

Spec-Zone.ru

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