public class LdapV3DNStrConverter extends LdapDNStrConverter
LdapDNStrConverter
,
X500Name
,
RDN
,
AVA
,
X500NameAttrMap
Modifier and Type | Field and Description |
---|---|
protected boolean |
acceptUnknownOids |
protected X500NameAttrMap |
attrMap |
protected static java.lang.String |
hexDigits |
protected static java.lang.String |
octoEndChars |
protected static java.lang.String |
quotedEndChars |
protected static java.lang.String |
specialChars |
protected static java.lang.String |
valueEndChars |
Constructor and Description |
---|
LdapV3DNStrConverter()
Constructs a LdapV3DNStrConverter using the global default
X500NameAttrMap and accept OIDs not in the default X500NameAttrMap.
|
LdapV3DNStrConverter(X500NameAttrMap attributeMap,
boolean doAcceptUnknownOids)
Constructs a LdapV3DNStrConverter using the specified X500NameAttrMap
and a boolean indicating whether to accept OIDs not listed in the
X500NameAttrMap.
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
encodeAVA(AVA ava)
Converts a AVA to a Ldap v3 DN String (except in unicode).
|
java.lang.String |
encodeDN(X500Name x500name)
Converts a X500Name object to a Ldap v3 DN string (except in unicode).
|
java.lang.String |
encodeOID(ObjectIdentifier oid)
Converts an OID to a attribute keyword in a Ldap v3 DN string
- either a keyword if known or a string of "1.2.3.4" syntax.
|
java.lang.String |
encodeRDN(RDN rdn)
Converts a RDN to a Ldap v3 DN string (except in unicode).
|
java.lang.String |
encodeString(java.lang.String valueStr)
converts a raw value string to a string in Ldap V3 DN string format.
|
java.lang.String |
encodeValue(DerValue attrValue,
ObjectIdentifier oid)
Converts a value as a DerValue to a string in a Ldap V3 DN String.
|
boolean |
getAcceptUnknownOids()
returns true if the converter accepts unregistered attributes i.e.
|
X500NameAttrMap |
getAttrMap()
gets the X500NameAttrMap used by the converter.
|
protected static char[] |
getStringFromHexpairs(char[] hexPairs)
Parse a sequence of hex pairs, each pair a UTF8 byte to a java string.
|
AVA |
parseAVA(java.io.PushbackReader in)
Parses a Ldap DN string with a AVA component
from a string reader to an AVA.
|
AVA |
parseAVA(java.io.PushbackReader in,
byte[] encodingOrder)
Like parseAVA(PushbackReader) with a DER encoding order given as
argument for Directory Strings.
|
AVA |
parseAVA(java.lang.String ava)
Parse a Ldap v3 DN string with a AVA component to a AVA.
|
AVA |
parseAVA(java.lang.String ava,
byte[] encodingOrder)
Like parseDN(String) with a DER encoding order given as argument for
Directory Strings.
|
ObjectIdentifier |
parseAVAKeyword(java.lang.String avaKeyword)
Converts a AVA keyword from a Ldap DN string to an ObjectIdentifier
from the attribute map or, if this keyword is an OID not
in the attribute map, create a new ObjectIdentifier for the keyword
if acceptUnknownOids is true.
|
DerValue |
parseAVAValue(byte[] berValue,
ObjectIdentifier oid)
Converts a value in BER encoding, for example given in octothorpe form
in a Ldap v3 dn string, to a DerValue.
|
DerValue |
parseAVAValue(java.lang.String avaValueString,
ObjectIdentifier oid)
Converts a AVA value from a Ldap dn string to a
DerValue according the attribute type.
|
DerValue |
parseAVAValue(java.lang.String avaValueString,
ObjectIdentifier oid,
byte[] encodingOrder)
Like parseAVAValue(String) with a DER encoding order given as argument
for Directory Strings.
|
X500Name |
parseDN(java.io.PushbackReader in)
Parses a Ldap DN string in a string reader to a X500Name.
|
X500Name |
parseDN(java.io.PushbackReader in,
byte[] encodingOrder)
Like parseDN(PushbackReader in) with a DER encoding order given as
argument for Directory Strings.
|
X500Name |
parseDN(java.lang.String dn)
Parse a Ldap v3 DN string to a X500Name.
|
X500Name |
parseDN(java.lang.String dn,
byte[] encodingOrder)
Like parseDN(String) with a DER encoding order given as argument for
Directory Strings.
|
RDN |
parseRDN(java.io.PushbackReader in)
Parses Ldap DN string with a rdn component
from a string reader to a RDN.
|
RDN |
parseRDN(java.io.PushbackReader in,
byte[] encodingOrder)
Like parseRDN(PushbackReader) with a DER encoding order given as
argument for Directory Strings.
|
RDN |
parseRDN(java.lang.String rdn)
Parse a Ldap v3 DN string with a RDN component to a RDN
|
RDN |
parseRDN(java.lang.String rdn,
byte[] encodingOrder)
Like parseRDN(String) with a DER encoding order given as argument for
Directory Strings.
|
getDefault, setDefault
protected X500NameAttrMap attrMap
protected boolean acceptUnknownOids
protected static final java.lang.String specialChars
protected static final java.lang.String valueEndChars
protected static final java.lang.String quotedEndChars
protected static final java.lang.String octoEndChars
protected static final java.lang.String hexDigits
public LdapV3DNStrConverter()
X500NameAttrMap
public LdapV3DNStrConverter(X500NameAttrMap attributeMap, boolean doAcceptUnknownOids)
attributeMap
- a X500NameAttrMapdoAcceptUnknownOids
- whether to convert unregistered OIDs
(oids not in the X500NameAttrMap)X500NameAttrMap
public X500Name parseDN(java.lang.String dn) throws java.io.IOException
parseDN
in class LdapDNStrConverter
dn
- a LDAP v3 DN Stringjava.io.IOException
- if an error occurs during the conversion.public X500Name parseDN(java.lang.String dn, byte[] encodingOrder) throws java.io.IOException
parseDN
in class LdapDNStrConverter
java.io.IOException
public RDN parseRDN(java.lang.String rdn) throws java.io.IOException
parseRDN
in class LdapDNStrConverter
rdn
- a LDAP v3 DN Stringjava.io.IOException
- if an error occurs during the conversion.public RDN parseRDN(java.lang.String rdn, byte[] encodingOrder) throws java.io.IOException
parseRDN
in class LdapDNStrConverter
java.io.IOException
public AVA parseAVA(java.lang.String ava) throws java.io.IOException
parseAVA
in class LdapDNStrConverter
ava
- a LDAP v3 DN stringjava.io.IOException
public AVA parseAVA(java.lang.String ava, byte[] encodingOrder) throws java.io.IOException
parseAVA
in class LdapDNStrConverter
java.io.IOException
public X500Name parseDN(java.io.PushbackReader in) throws java.io.IOException
in
- Pushback string reader for a Ldap DN string.
The pushback reader must have a pushback buffer
size > 2.java.io.IOException
- if any reading or parsing error occurs.public X500Name parseDN(java.io.PushbackReader in, byte[] encodingOrder) throws java.io.IOException
java.io.IOException
public RDN parseRDN(java.io.PushbackReader in) throws java.io.IOException
in
- Pushback string reader containing a Ldap DN string with
at least one rdn component.
The pushback reader must have a pushback buffer
size > 2.java.io.IOException
- if any read or parse error occurs.public RDN parseRDN(java.io.PushbackReader in, byte[] encodingOrder) throws java.io.IOException
java.io.IOException
public AVA parseAVA(java.io.PushbackReader in) throws java.io.IOException
in
- a Pushback reader containg a Ldap string with
at least one AVA component.
The Pushback reader must have a pushback buffer
size > 2.java.io.IOException
public AVA parseAVA(java.io.PushbackReader in, byte[] encodingOrder) throws java.io.IOException
java.io.IOException
public ObjectIdentifier parseAVAKeyword(java.lang.String avaKeyword) throws java.io.IOException
avaKeyword
- AVA keyword from a Ldap DN string.java.io.IOException
- if the keyword is an OID not in the attribute
map and acceptUnknownOids is false, or
if an error occurs during conversion.public DerValue parseAVAValue(java.lang.String avaValueString, ObjectIdentifier oid) throws java.io.IOException
avaValueString
- a attribute value from a Ldap DN string.oid
- OID of the attribute.java.io.IOException
- if an error occurs during conversion.AVAValueConverter
public DerValue parseAVAValue(java.lang.String avaValueString, ObjectIdentifier oid, byte[] encodingOrder) throws java.io.IOException
java.io.IOException
public DerValue parseAVAValue(byte[] berValue, ObjectIdentifier oid) throws java.io.IOException
NOTE: only DER encoded values are supported for the BER encoded value.
berValue
- a value in BER encodingoid
- ObjectIdentifier of the attribute.java.io.IOException
- if an error occurs during conversion.public java.lang.String encodeDN(X500Name x500name) throws java.io.IOException
encodeDN
in class LdapDNStrConverter
x500name
- a X500Namejava.io.IOException
- if an error is encountered during conversion.public java.lang.String encodeRDN(RDN rdn) throws java.io.IOException
encodeRDN
in class LdapDNStrConverter
rdn
- a RDNjava.io.IOException
- if an error is encountered during conversion.public java.lang.String encodeAVA(AVA ava) throws java.io.IOException
encodeAVA
in class LdapDNStrConverter
ava
- an AVAjava.io.IOException
- If an error is encountered during exception.public java.lang.String encodeOID(ObjectIdentifier oid) throws java.io.IOException
oid
- a ObjectIdentifierjava.io.IOException
- if an error is encountered during conversion.public java.lang.String encodeValue(DerValue attrValue, ObjectIdentifier oid) throws java.io.IOException
attrValue
- a value as a DerValue.oid
- OID for the attribute.java.io.IOException
- if an error occurs during conversion.public java.lang.String encodeString(java.lang.String valueStr)
valueStr
- a 'raw' value string.public X500NameAttrMap getAttrMap()
public boolean getAcceptUnknownOids()
protected static char[] getStringFromHexpairs(char[] hexPairs) throws java.io.UnsupportedEncodingException
java.io.UnsupportedEncodingException