e.g., If a provider master file contained a mapping from the property "GssApiMechanism.1.2.840.113554.1.2.2" to the class name "com.foo.krb5.Krb5GssFactory", then the GSS-API framework would assume that com.foo.krb5.Krb5GssFactory implements the MechanismFactory interface and that it can be used to obtain elements required by for supporting this mechanism.
| Modifier and Type | Method and Description |
|---|---|
| public GSSCredentialSpi | getCredentialElement(GSSNameSpi
the mechanism level name element for the entity whose
credential is desired. A null value indicates that a mechanism
dependent default choice is to be made. name, int indicates the lifetime (in seconds) that is
requested for this credential to be used at the context initiator's
end. This value should be ignored if the usage is
ACCEPT_ONLY. Predefined constants are available in the
org.ietf.jgss.GSSCredential interface. initLifetime, int indicates the lifetime (in seconds) that is
requested for this credential to be used at the context acceptor's
end. This value should be ignored if the usage is
INITIATE_ONLY. Predefined constants are available in the
org.ietf.jgss.GSSCredential interface. acceptLifetime, int One of the values GSSCredential.INIATE_ONLY,
GSSCredential.ACCEPT_ONLY, and GSSCredential.INITIATE_AND_ACCEPT. usage)Creates a credential element for this mechanism to be included as part of a GSSCredential implementation. |
| public GSSContextSpi | getMechanismContext(GSSNameSpi
the name element from this mechanism that represents the
peer peer, GSSCredentialSpi a credential element for the context
initiator obtained previously from this mechanism. The identity of
the context initiator can be obtained from this credential. Passing
a value of null here indicates that a default entity of the
mechanism's choice should be assumed to be the context initiator and
that default credentials should be applied. myInitiatorCred, int the requested lifetime (in seconds) for the security
context. Predefined constants are available in the
org.ietf.jgss.GSSContext interface. lifetime)Creates a security context for this mechanism so that it can be used on the context initiator's side. |
| public GSSContextSpi | getMechanismContext(GSSCredentialSpi
a credential element for the context acceptor
obtained previously from this mechanism. The identity of the context
acceptor can be obtained from this credential. Passing a value of
null here indicates that the default entity of the mechanism's
choice should be assumed to be the context acceptor and default
credentials should be applied. myAcceptorCred)Creates a security context for this mechanism so that it can be used on the context acceptor's side. |
| public GSSContextSpi | getMechanismContext(byte[]
the bytes representing this security context exportedContext)Creates a security context from a previously exported (serialized) security context. |
| public Oid | |
| public GSSNameSpi | getNameElement(String
a string containing the characters describing this
entity to the mechanism nameStr, Oid an Oid serving as a clue as to how the mechanism should
interpret the nameStr nameType)Creates a name element for this mechanism to be included as part of a GSSName implementation. |
| public GSSNameSpi | getNameElement(byte[]
the bytes describing this entity to the mechanism name, Oid an Oid serving as a clue as to how the mechanism should
interpret the nameStr nameType)This is a variation of the factory method that accepts a String for the characters that make up the name. |
| public Oid[] | Returns: an array of the Oid's corresponding to the different GSS-API nametypes supportedReturns the GSS-API nametypes that this mechanism can support. |
| public Provider |
| getCredentialElement | back to summary |
|---|---|
| public GSSCredentialSpi getCredentialElement(GSSNameSpi name, int initLifetime, int acceptLifetime, int usage) throws GSSException Creates a credential element for this mechanism to be included as part of a GSSCredential implementation. A GSSCredential is conceptually a container class of several credential elements from different mechanisms. A GSS-API credential can be used either for initiating GSS security contexts or for accepting them. This method also accepts parameters that indicate what usage is expected and how long the life of the credential should be. It is not necessary that the mechanism honor the request for lifetime. An application will always query an acquired GSSCredential to determine what lifetime it got back. Not all mechanisms support the concept of one credential element that can be used for both initiating and accepting a context. In the event that an application requests usage INITIATE_AND_ACCEPT for a credential from such a mechanism, the GSS framework will need to obtain two different credential elements from the mechanism, one that will have usage INITIATE_ONLY and another that will have usage ACCEPT_ONLY. The mechanism will help the GSS-API realize this by returning a credential element with usage INITIATE_ONLY or ACCEPT_ONLY prompting it to make another call to getCredentialElement, this time with the other usage mode. The mechanism indicates the missing mode by returning a 0 lifetime for it.
| |
| getMechanismContext | back to summary |
|---|---|
| public GSSContextSpi getMechanismContext(GSSNameSpi peer, GSSCredentialSpi myInitiatorCred, int lifetime) throws GSSException Creates a security context for this mechanism so that it can be used on the context initiator's side.
| |
| getMechanismContext | back to summary |
|---|---|
| public GSSContextSpi getMechanismContext(GSSCredentialSpi myAcceptorCred) throws GSSException Creates a security context for this mechanism so that it can be used on the context acceptor's side.
| |
| getMechanismContext | back to summary |
|---|---|
| public GSSContextSpi getMechanismContext(byte[] exportedContext) throws GSSException Creates a security context from a previously exported (serialized) security context. Note that this is different from Java serialization and is defined at a mechanism level to interoperate over the wire with non-Java implementations. Either the initiator or the acceptor can export and then import a security context. Implementations of mechanism contexts are not required to implement exporting and importing.
| |
| getMechanismOid | back to summary |
|---|---|
| public Oid getMechanismOid() Returns the Oid of the mechanism that this factory supports.
| |
| getNameElement | back to summary |
|---|---|
| public GSSNameSpi getNameElement(String nameStr, Oid nameType) throws GSSException Creates a name element for this mechanism to be included as part of a GSSName implementation. A GSSName is conceptually a container class of several name elements from different mechanisms. A GSSName can be created either with a String or with a sequence of bytes. This factory method accepts the name in a String. Such a name can generally be assumed to be printable and may be returned from the name element's toString() method.
| |
| getNameElement | back to summary |
|---|---|
| public GSSNameSpi getNameElement(byte[] name, Oid nameType) throws GSSException This is a variation of the factory method that accepts a String for the characters that make up the name. Usually the String characters are assumed to be printable. The bytes passed in to this method have to be converted to characters using some encoding of the mechanism's choice. It is recommended that UTF-8 be used. (Note that UTF-8 preserves the encoding for 7-bit ASCII characters.) An exported name will generally be passed in using this method.
| |
| getNameTypes | back to summary |
|---|---|
| public Oid[] getNameTypes() throws GSSException Returns the GSS-API nametypes that this mechanism can support. Having this method helps the GSS-Framework decide quickly if a certain mechanism can be skipped when importing a name.
| |
| getProvider | back to summary |
|---|---|
| public Provider getProvider() Returns the provider that this factory came from.
| |