Credentials (Eagle Core API)

java.lang.Object
- com.neeve.service.messages.Credentials

All Implemented Interfaces:: IRogValidatable, ICredentials

@Generated(value="com.neeve.adm.AdmJsonGenerator",
           date="Fri Dec 05 11:53:59 EST 2025")
 @AdmGenerated(encoding="Json",
              compatLevel="4.1.0",
              admVersion="Unknown Version",
              date="12/5/25 11:53 AM",
              buildInfo="nvx-eagle-2.9-SNAPSHOT Json Encoding")
 @AdmFactoryInfo(factoryClass=MessageFactory.class,
                vfid=132,
                ofid=132,
                typeId=1003)
public final class Credentials
extends Object
implements ICredentials

The 'Credentials' type.

ADM Details

ADM Type	Embedded Entity
Factory	MessageFactory

ADM Field Summary

Field	Type	Id	Description
password	String	32736	No doc provided.
username	String	32737	No doc provided.

Field Summary

Fields
Modifier and Type Field and Description

static Credentials[] EMPTY_ARRAY
A preallocated empty array used to avoid garbage when returning empty arrays of this type.

Fields
Modifier and Type	Field and Description
`static Credentials[]`	`EMPTY_ARRAY` A preallocated empty array used to avoid garbage when returning empty arrays of this type.

Constructor Summary

Constructors
Constructor and Description

Credentials()

Constructors
Constructor and Description
`Credentials()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Credentials`	`acquire()`
`void`	`clearContent()`
`void`	`clearPassword()` Clears the value of 'password'.
`void`	`clearUsername()` Clears the value of 'username'.
`Object`	`clone()` Creates a clone of this object.
`Credentials`	`copy()`
`void`	`copyInto(Credentials copy)`
`static Credentials`	`create()`
`static Credentials`	`createFrom(byte[] serializedJson)`
`static Credentials`	`createFromJson(String json)`
`static Credentials`	`createFromSerializedJson(byte[] serializedJson)`
`static Credentials`	`createFromSerializedJson(ByteBuffer serializedJson)`
`Credentials`	`deserializeFromByteArray(byte[] array)`
`Credentials`	`deserializeFromByteBuffer(ByteBuffer buffer)`
`Credentials`	`deserializeFromNative(long address, int addressOffset, int length)`
`void`	`dispose()`
`boolean`	`getIsReadOnly()`
`int`	`getOwnerCount()`
`String`	`getPassword()` Gets the value of 'password'.
`static int`	`getPasswordFieldId()`
`<T extends XString> T`	`getPasswordTo(XString.Factory<T> factory)` Copies the value of this String field into a new XString from the given factory.
`void`	`getPasswordTo(XString val)` Copies the value of 'password' into the provided XString.
`XString`	`getPasswordUnsafe()` Gets the raw value of 'password'.
`int`	`getSerializeToNativeLength()`
`String`	`getUsername()` Gets the value of 'username'.
`static int`	`getUsernameFieldId()`
`<T extends XString> T`	`getUsernameTo(XString.Factory<T> factory)` Copies the value of this String field into a new XString from the given factory.
`void`	`getUsernameTo(XString val)` Copies the value of 'username' into the provided XString.
`XString`	`getUsernameUnsafe()` Gets the raw value of 'username'.
`void`	`getValidationErrors(List<XString> results, String errorPrefix)`
`boolean`	`hasPassword()` Checks for the presence of 'password'.
`boolean`	`hasUsername()` Checks for the presence of 'username'.
`boolean`	`isBufferBacked()`
`boolean`	`isReferenceCounted()`
`boolean`	`isValid()`
`void`	`lendPassword(XString val)` Lends the value of 'password' to this object.
`void`	`lendUsername(XString val)` Lends the value of 'username' to this object.
`byte[]`	`serializeToByteArray()`
`ByteBuffer`	`serializeToByteBuffer()`
`int`	`serializeToNative(long address, int addressOffset)`
`void`	`setAsReadOnly()`
`void`	`setPassword(String val)` Sets the value of 'password'.
`void`	`setPasswordFrom(long val)` Sets the value of this String field to the given numeric value.
`void`	`setPasswordFrom(XString val)` Copies the provided XString value into this object's 'password'.
`void`	`setUsername(String val)` Sets the value of 'username'.
`void`	`setUsernameFrom(long val)` Sets the value of this String field to the given numeric value.
`void`	`setUsernameFrom(XString val)` Copies the provided XString value into this object's 'username'.
`String`	`toString()`

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - EMPTY_ARRAY
```
public static final Credentials[] EMPTY_ARRAY
```
    A preallocated empty array used to avoid garbage when returning empty arrays of this type.
- Constructor Detail
  - Credentials
```
public Credentials()
```
- Method Detail
  - create
```
public static Credentials create()
```
  - createFromJson
```
public static Credentials createFromJson(String json)
```
  - createFromSerializedJson
```
public static Credentials createFromSerializedJson(ByteBuffer serializedJson)
```
  - createFromSerializedJson
```
public static Credentials createFromSerializedJson(byte[] serializedJson)
```
  - createFrom
```
public static Credentials createFrom(byte[] serializedJson)
```
  - clearContent
```
public final void clearContent()
```
  - setAsReadOnly
```
public final void setAsReadOnly()
```
  - getIsReadOnly
```
public final boolean getIsReadOnly()
```
  - getUsernameFieldId
```
public static final int getUsernameFieldId()
```
  - setUsername
```
public final void setUsername(String val)
```
    Description copied from interface: ICredentials
    
    Sets the value of 'username'.
    
    Specified by:
    
    setUsername in interface ICredentials
    
    Parameters:
    
    val - The value to set.
  - getUsername
```
public final String getUsername()
```
    Description copied from interface: ICredentials
    
    Gets the value of 'username'.
    
    Specified by:
    
    getUsername in interface ICredentials
    
    Returns:
    
    The value of 'username'
  - lendUsername
```
public final void lendUsername(XString val)
```
    Description copied from interface: ICredentials
    
    Lends the value of 'username' to this object.
    This method is equivalent to setUsername except that it allows this object to defer copying the value until this object is next serialized. This means that the caller must not modify or dispose the value being passed in to this method.
    Usage Notes
    Note that implementations of this method are not strictly required to defer copying the value, this method only provides the hint to this object that it may defer copy. The caller must ensure that the value value is immutable and not disposed regardless.
    Note, also, that unlike lendXXX methods for embedded entities, this method does not attempt to acquire or dispose of the value passed in even if the value is poolable.
    
    Specified by:
    
    lendUsername in interface ICredentials
    
    Parameters:
    
    val - The value to set.
  - setUsernameFrom
```
public final void setUsernameFrom(long val)
```
    Description copied from interface: ICredentials
    
    Sets the value of this String field to the given numeric value.
    NOTE:
    This is the same as calling ICredentials.setUsername(String). with Long.valueOf(val).toString(), except that using this method is a zero garbage operation for Xbuf encoding.
    
    Specified by:
    
    setUsernameFrom in interface ICredentials
  - getUsernameTo
```
public final <T extends XString> T getUsernameTo(XString.Factory<T> factory)
```
    Description copied from interface: ICredentials
    
    Copies the value of this String field into a new XString from the given factory.
    If the value of this field is not null this method creates an XString from the provided Factory, copies this field's value into the type, and returns the new XString.);
    This is a zero garbage operation if the provided factory is backed by a pool and the pool; has available instances;
    
    Specified by:
    
    getUsernameTo in interface ICredentials
    
    Parameters:
    
    factory - The factory from which to get the XString to copy into and return
    
    Returns:
    
    a new XString from the provided factory if this field is set or null.
  - setUsernameFrom
```
public final void setUsernameFrom(XString val)
```
    Description copied from interface: ICredentials
    
    Copies the provided XString value into this object's 'username'.
    NOTE:
    This is a Zero Garbage operation for XBuf encoded objects. Additionally, this setter can be more efficient than ICredentials.setUsername(String) because it avoids encoding the value into a String if the given XString is already encoded.
    
    Specified by:
    
    setUsernameFrom in interface ICredentials
  - getUsernameTo
```
public final void getUsernameTo(XString val)
```
    Description copied from interface: ICredentials
    
    Copies the value of 'username' into the provided XString.
    NOTE:
    This is a Zero Garbage operation for XBuf encoded objects. Additionally, this getter can be more efficient than ICredentials.getUsername() bec because it can avoid decoding the value into an String.
    
    Specified by:
    
    getUsernameTo in interface ICredentials
    
    See Also:
    
    ICredentials.getUsername()
  - getUsernameUnsafe
```
public final XString getUsernameUnsafe()
```
    Description copied from interface: ICredentials
    
    Gets the raw value of 'username'.
    NOTE:
    This method retrieves the raw value backed by this object's buffer. This is a useful operation when copying this field value to another object because it avoids copying the data into an intermediate XString and instead allows direct byte transfer from the raw value to the target object.
    However, this accessor is inherently unsafe because the buffer backing this object can be changed which would consequently invalidate the XString returned by this method. Consequently, the caller must not retain the returned raw value beyond the scope of this object's lifespan and access to the raw value follows the same threading rules as access to this object.
    Additionally, the caller must not in any way mutate or modify the returned value as doing so could corrupt this object's backing buffer.
    
    Specified by:
    
    getUsernameUnsafe in interface ICredentials
    
    Returns:
    
    the field's raw value
    
    See Also:
    
    ICredentials.getUsername()
  - clearUsername
```
public final void clearUsername()
```
    Description copied from interface: ICredentials
    
    Clears the value of 'username'.
    
    Specified by:
    
    clearUsername in interface ICredentials
    
    See Also:
    
    ICredentials.setUsername(String)
  - hasUsername
```
public final boolean hasUsername()
```
    Description copied from interface: ICredentials
    
    Checks for the presence of 'username'.
    
    Specified by:
    
    hasUsername in interface ICredentials
    
    See Also:
    
    ICredentials.getUsername()
  - getPasswordFieldId
```
public static final int getPasswordFieldId()
```
  - setPassword
```
public final void setPassword(String val)
```
    Description copied from interface: ICredentials
    
    Sets the value of 'password'.
    
    Specified by:
    
    setPassword in interface ICredentials
    
    Parameters:
    
    val - The value to set.
  - getPassword
```
public final String getPassword()
```
    Description copied from interface: ICredentials
    
    Gets the value of 'password'.
    
    Specified by:
    
    getPassword in interface ICredentials
    
    Returns:
    
    The value of 'password'
  - lendPassword
```
public final void lendPassword(XString val)
```
    Description copied from interface: ICredentials
    
    Lends the value of 'password' to this object.
    This method is equivalent to setPassword except that it allows this object to defer copying the value until this object is next serialized. This means that the caller must not modify or dispose the value being passed in to this method.
    Usage Notes
    Note that implementations of this method are not strictly required to defer copying the value, this method only provides the hint to this object that it may defer copy. The caller must ensure that the value value is immutable and not disposed regardless.
    Note, also, that unlike lendXXX methods for embedded entities, this method does not attempt to acquire or dispose of the value passed in even if the value is poolable.
    
    Specified by:
    
    lendPassword in interface ICredentials
    
    Parameters:
    
    val - The value to set.
  - setPasswordFrom
```
public final void setPasswordFrom(long val)
```
    Description copied from interface: ICredentials
    
    Sets the value of this String field to the given numeric value.
    NOTE:
    This is the same as calling ICredentials.setPassword(String). with Long.valueOf(val).toString(), except that using this method is a zero garbage operation for Xbuf encoding.
    
    Specified by:
    
    setPasswordFrom in interface ICredentials
  - getPasswordTo
```
public final <T extends XString> T getPasswordTo(XString.Factory<T> factory)
```
    Description copied from interface: ICredentials
    
    Copies the value of this String field into a new XString from the given factory.
    If the value of this field is not null this method creates an XString from the provided Factory, copies this field's value into the type, and returns the new XString.);
    This is a zero garbage operation if the provided factory is backed by a pool and the pool; has available instances;
    
    Specified by:
    
    getPasswordTo in interface ICredentials
    
    Parameters:
    
    factory - The factory from which to get the XString to copy into and return
    
    Returns:
    
    a new XString from the provided factory if this field is set or null.
  - setPasswordFrom
```
public final void setPasswordFrom(XString val)
```
    Description copied from interface: ICredentials
    
    Copies the provided XString value into this object's 'password'.
    NOTE:
    This is a Zero Garbage operation for XBuf encoded objects. Additionally, this setter can be more efficient than ICredentials.setPassword(String) because it avoids encoding the value into a String if the given XString is already encoded.
    
    Specified by:
    
    setPasswordFrom in interface ICredentials
  - getPasswordTo
```
public final void getPasswordTo(XString val)
```
    Description copied from interface: ICredentials
    
    Copies the value of 'password' into the provided XString.
    NOTE:
    This is a Zero Garbage operation for XBuf encoded objects. Additionally, this getter can be more efficient than ICredentials.getPassword() bec because it can avoid decoding the value into an String.
    
    Specified by:
    
    getPasswordTo in interface ICredentials
    
    See Also:
    
    ICredentials.getPassword()
  - getPasswordUnsafe
```
public final XString getPasswordUnsafe()
```
    Description copied from interface: ICredentials
    
    Gets the raw value of 'password'.
    NOTE:
    This method retrieves the raw value backed by this object's buffer. This is a useful operation when copying this field value to another object because it avoids copying the data into an intermediate XString and instead allows direct byte transfer from the raw value to the target object.
    However, this accessor is inherently unsafe because the buffer backing this object can be changed which would consequently invalidate the XString returned by this method. Consequently, the caller must not retain the returned raw value beyond the scope of this object's lifespan and access to the raw value follows the same threading rules as access to this object.
    Additionally, the caller must not in any way mutate or modify the returned value as doing so could corrupt this object's backing buffer.
    
    Specified by:
    
    getPasswordUnsafe in interface ICredentials
    
    Returns:
    
    the field's raw value
    
    See Also:
    
    ICredentials.getPassword()
  - clearPassword
```
public final void clearPassword()
```
    Description copied from interface: ICredentials
    
    Clears the value of 'password'.
    
    Specified by:
    
    clearPassword in interface ICredentials
    
    See Also:
    
    ICredentials.setPassword(String)
  - hasPassword
```
public final boolean hasPassword()
```
    Description copied from interface: ICredentials
    
    Checks for the presence of 'password'.
    
    Specified by:
    
    hasPassword in interface ICredentials
    
    See Also:
    
    ICredentials.getPassword()
  - serializeToByteArray
```
public final byte[] serializeToByteArray()
```
  - serializeToByteBuffer
```
public final ByteBuffer serializeToByteBuffer()
```
  - isBufferBacked
```
public final boolean isBufferBacked()
```
  - getSerializeToNativeLength
```
public final int getSerializeToNativeLength()
```
  - serializeToNative
```
public final int serializeToNative(long address,
                                   int addressOffset)
```
  - deserializeFromByteArray
```
public final Credentials deserializeFromByteArray(byte[] array)
```
  - deserializeFromByteBuffer
```
public final Credentials deserializeFromByteBuffer(ByteBuffer buffer)
```
  - deserializeFromNative
```
public final Credentials deserializeFromNative(long address,
                                               int addressOffset,
                                               int length)
```
  - isReferenceCounted
```
public final boolean isReferenceCounted()
```
  - acquire
```
public final Credentials acquire()
```
  - getOwnerCount
```
public final int getOwnerCount()
```
  - dispose
```
public final void dispose()
```
  - clone
```
public final Object clone()
```
    Creates a clone of this object.
    This method differs from the copy() method in that:
    - For protobuf and xbuf generated objects pass-through fields are not preserved. Pass through fields are fields not defined by ADM model that generated this class, but may exist in the backing buffer or protobuf message for the object.
    - The copy method may replace empty arrays with a null value whereas this method preserves empty array fields.
    Overrides:
    
    clone in class Object
  - copy
```
public final Credentials copy()
```
  - copyInto
```
public final void copyInto(Credentials copy)
```
  - isValid
```
public final boolean isValid()
```
    Specified by:
    
    isValid in interface IRogValidatable
  - getValidationErrors
```
public final void getValidationErrors(List<XString> results,
                                      String errorPrefix)
```
    Specified by:
    
    getValidationErrors in interface IRogValidatable
  - toString
```
public final String toString()
```
    Overrides:
    
    toString in class Object

Class Credentials

ADM Details

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

EMPTY_ARRAY

Constructor Detail

Credentials

Method Detail

create

createFromJson

createFromSerializedJson

createFromSerializedJson

createFrom

clearContent

setAsReadOnly

getIsReadOnly

getUsernameFieldId

setUsername

getUsername

lendUsername

Usage Notes

setUsernameFrom

getUsernameTo

setUsernameFrom

getUsernameTo

getUsernameUnsafe

clearUsername

hasUsername

getPasswordFieldId

setPassword

getPassword

lendPassword

Usage Notes

setPasswordFrom

getPasswordTo

setPasswordFrom

getPasswordTo

getPasswordUnsafe

clearPassword

hasPassword

serializeToByteArray

serializeToByteBuffer

isBufferBacked

getSerializeToNativeLength

serializeToNative

deserializeFromByteArray

deserializeFromByteBuffer

deserializeFromNative

isReferenceCounted

acquire

getOwnerCount

dispose

clone

copy

copyInto

isValid

getValidationErrors

toString