net.java.truelicense.core.x500

Class GenericX500PrincipalBuilder<This extends GenericX500PrincipalBuilder<This>>

java.lang.Object

net.java.truelicense.core.x500.GenericX500PrincipalBuilder<This>

Type Parameters:

This - the type of this generic X.500 principal builder.

All Implemented Interfaces:

Builder<X500Principal>

Direct Known Subclasses:

X500PrincipalBuilder

public abstract class GenericX500PrincipalBuilder<This extends GenericX500PrincipalBuilder<This>>
extends Object
implements Builder<X500Principal>

A generic builder for an X500Principal.

This abstract class is provided so that sub-classes can easily add methods which return this without the need to cast its type by clients. Example:

 
 class MyBuilder extends GenericX500PrincipalBuilder<MyBuilder> {
     MyBuilder addFOO(String value) {
         addKeyword("FOO", "1.2.3.4.5.6.7.8.9");
         return addAttribute("FOO", value);
     }
 }

 class MyClient {
     X500Principal create() {
         return new MyBuilder()
                 .addAttribute("CN", "Duke")
                 .addFOO("a")
                 .build();
     }
 }
 

Notice that the call to addFOO is compilable because the previous call to addAttribute is defined to return the generic type parameter This.

Since:

TrueLicense 2.3

Author:

Christian Schlichtherle

Constructor Summary

Constructors

Constructor and Description
GenericX500PrincipalBuilder()

Method Summary

Modifier and Type	Method and Description
This	addAttribute(String type, String value) Adds an X.500 attribute to the distinguished name.
This	addAttribute(X500AttributeTypeKeyword keyword, String value) Adds an X.500 attribute to the distinguished name.
This	addC(String value) Equivalent to addAttribute(C, value).
This	addCN(String value) Equivalent to addAttribute(CN, value).
This	addDC(String value) Equivalent to addAttribute(DC, value).
This	addDNQ(String value) Equivalent to addAttribute(DNQ, value).
This	addDNQUALIFIER(String value) Equivalent to addAttribute(DNQUALIFIER, value).
This	addEMAILADDRESS(String value) Equivalent to addAttribute(EMAILADDRESS, value).
This	addGENERATION(String value) Equivalent to addAttribute(GENERATION, value).
This	addGIVENNAME(String value) Equivalent to addAttribute(GIVENNAME, value).
This	addINITIALS(String value) Equivalent to addAttribute(INITIALS, value).
This	addKeyword(String keyword, String oid) Adds a mapping from a keyword to an Object Identifier (OID).
This	addL(String value) Equivalent to addAttribute(L, value).
This	addO(String value) Equivalent to addAttribute(O, value).
This	addOU(String value) Equivalent to addAttribute(OU, value).
This	addSERIALNUMBER(String value) Equivalent to addAttribute(SERIALNUMBER, value).
This	addST(String value) Equivalent to addAttribute(ST, value).
This	addSTREET(String value) Equivalent to addAttribute(STREET, value).
This	addSURNAME(String value) Equivalent to addAttribute(SURNAME, value).
This	addT(String value) Equivalent to addAttribute(T, value).
This	addUID(String value) Equivalent to addAttribute(UID, value).
X500Principal	build() Returns the X.500 principal with the distinguished name as built from the sequence of attribute type and value pairs.

Methods inherited from class java.lang.Object

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

Constructor Detail

GenericX500PrincipalBuilder

public GenericX500PrincipalBuilder()

Method Detail

addAttribute

public This addAttribute(String type,
                         @Nullable
                         String value)

Adds an X.500 attribute to the distinguished name.

Parameters:

type - the attribute type, which can be referenced by a keyword or its OID.

value - the nullable, unquoted and unescaped attribute value.

Returns:

this

See Also:

addKeyword(java.lang.String, java.lang.String)

addAttribute

public This addAttribute(X500AttributeTypeKeyword keyword,
                         @Nullable
                         String value)

Adds an X.500 attribute to the distinguished name.

Parameters:

keyword - the attribute type keyword.

value - the nullable, unquoted and unescaped attribute value.

Returns:

this

addC

public This addC(@Nullable
                 String value)

Equivalent to addAttribute(C, value).

addCN

public This addCN(@Nullable
                  String value)

Equivalent to addAttribute(CN, value).

addDC

public This addDC(@Nullable
                  String value)

Equivalent to addAttribute(DC, value).

addDNQ

public This addDNQ(@Nullable
                   String value)

Equivalent to addAttribute(DNQ, value).

addDNQUALIFIER

public This addDNQUALIFIER(@Nullable
                           String value)

Equivalent to addAttribute(DNQUALIFIER, value).

addEMAILADDRESS

public This addEMAILADDRESS(@Nullable
                            String value)

Equivalent to addAttribute(EMAILADDRESS, value).

addGENERATION

public This addGENERATION(@Nullable
                          String value)

Equivalent to addAttribute(GENERATION, value).

addGIVENNAME

public This addGIVENNAME(@Nullable
                         String value)

Equivalent to addAttribute(GIVENNAME, value).

addINITIALS

public This addINITIALS(@Nullable
                        String value)

Equivalent to addAttribute(INITIALS, value).

addKeyword

public This addKeyword(String keyword,
                       @Nullable
                       String oid)

Adds a mapping from a keyword to an Object Identifier (OID).

Parameters:

keyword - the attribute type keyword.

oid - the nullable OID.

Returns:

this

addL

public This addL(@Nullable
                 String value)

Equivalent to addAttribute(L, value).

addO

public This addO(@Nullable
                 String value)

Equivalent to addAttribute(O, value).

addOU

public This addOU(@Nullable
                  String value)

Equivalent to addAttribute(OU, value).

addSERIALNUMBER

public This addSERIALNUMBER(@Nullable
                            String value)

Equivalent to addAttribute(SERIALNUMBER, value).

addST

public This addST(@Nullable
                  String value)

Equivalent to addAttribute(ST, value).

addSTREET

public This addSTREET(@Nullable
                      String value)

Equivalent to addAttribute(STREET, value).

addSURNAME

public This addSURNAME(@Nullable
                       String value)

Equivalent to addAttribute(SURNAME, value).

addT

public This addT(@Nullable
                 String value)

Equivalent to addAttribute(T, value).

addUID

public This addUID(@Nullable
                   String value)

Equivalent to addAttribute(UID, value).

build

public X500Principal build()

Returns the X.500 principal with the distinguished name as built from the sequence of attribute type and value pairs.

Specified by:

build in interface Builder<X500Principal>

Throws:

IllegalArgumentException - if an attribute type is unknown or its keyword mapping is invalid.