java.lang.Object
- org.apache.directory.fortress.core.model.FortEntity
- - org.apache.directory.fortress.core.model.User
  - - org.apache.directory.fortress.core.ant.UserAnt

All Implemented Interfaces:

Serializable, Constraint
```
public class UserAnt
extends User
```
Entity is used by custom Apache Ant task for special handling of collections. This is necessary because the Ant parser cannot deal with complex data attribute types. The class extends a base entity.

Author:

Apache Directory Project

See Also:

Serialized Form

Field Summary
- Fields inherited from class org.apache.directory.fortress.core.model.FortEntity
  adminSession, contextId, modCode, modId, sequenceId

Constructor Summary

Constructors
Constructor Description

UserAnt()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`getAddresses()`	Return addresses
`String`	`getBuilding()`	Return the building designator.
`String`	`getCity()`	Return the city name.
`String`	`getCountry()`	Return the country name.
`String`	`getDepartmentNumber()`	Return department number.
`String`	`getEmail()`	Return email for user.
`String`	`getMobile()`	Return a mobile number for the user.
`String`	`getPhone()`	Return phone for a user.
`String`	`getPhoto()`	Return the user's jpg photo
`String`	`getPostalCode()`	Return postal code.
`String`	`getPostOfficeBox()`	Return post ofice box associated with a user.
`String`	`getRoomNumber()`	Return room number.
`String`	`getState()`	Return the state name.
`String`	`getUserProps()`	Return user properties
`static byte[]`	`readJpegFile(String fileName)`	Read the image from specified file location and return as a byte array.
`void`	`setAddresses(String addresses)`	Set addresses
`void`	`setBuilding(String building)`	Set building designator.
`void`	`setCity(String city)`	Set the city name.
`void`	`setCountry(String country)`	Set the country name
`void`	`setDepartmentNumber(String departmentNumber)`	Set department number.
`void`	`setEmail(String email)`	A User may have many phones set on their record.
`void`	`setMobile(String mobile)`	Set a mobile number on the user.
`void`	`setPhone(String phone)`	Set a phone on the user.
`void`	`setPhoto(String photo)`	Set a photo on user's record
`void`	`setPostalCode(String postalCode)`	Set a postal code on address.
`void`	`setPostOfficeBox(String postOfficeBox)`	Set a post office box
`void`	`setRoomNumber(String roomNumber)`	Set the room number.
`void`	`setState(String state)`	Set the state name of the user.
`void`	`setUserProps(String userProps)`	Set user properties.

Methods inherited from class org.apache.directory.fortress.core.model.User
addProperties, addProperty, delAdminRole, delRole, equals, getAddress, getAdminRoles, getBeginDate, getBeginLockDate, getBeginTime, getCn, getConstraints, getDayMask, getDescription, getDisplayName, getDn, getEmails, getEmployeeType, getEndDate, getEndLockDate, getEndTime, getGecos, getGidNumber, getHomeDirectory, getInternalId, getJpegPhoto, getLoginShell, getMobiles, getName, getNewPassword, getOu, getPassword, getPhones, getProperties, getProperty, getProps, getPwPolicy, getRawData, getRoles, getSn, getTimeout, getTitle, getUidNumber, getUserId, hashCode, isLocked, isReset, isSystem, isTemporalSet, setAddress, setAdminRole, setAdminRoleName, setAdminRoles, setBeginDate, setBeginLockDate, setBeginTime, setCn, setDayMask, setDescription, setDisplayName, setDn, setEmails, setEmployeeType, setEndDate, setEndLockDate, setEndTime, setGecos, setGidNumber, setHomeDirectory, setInternalId, setInternalId, setJpegPhoto, setLocked, setLoginShell, setMobiles, setName, setNewPassword, setOu, setPassword, setPhones, setProps, setPwPolicy, setReset, setRole, setRoleName, setRoles, setSn, setSystem, setTimeout, setTitle, setUidNumber, setUserId, toString

Methods inherited from class org.apache.directory.fortress.core.model.FortEntity
getAdminSession, getContextId, getModCode, getModId, getSequenceId, setAdminSession, setContextId, setModCode, setSequenceId

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

- Constructor Detail
  - UserAnt
```
public UserAnt()
```
- Method Detail
  - getAddresses
```
public String getAddresses()
```
    Return addresses
    
    Returns:
    
    String containing addresses
  - setAddresses
```
public void setAddresses(String addresses)
```
    Set addresses
    
    Parameters:
    
    addresses - String containing comma separated address names
  - getUserProps
```
public String getUserProps()
```
    Return user properties
    
    Returns:
    
    String containing user properties
  - setUserProps
```
public void setUserProps(String userProps)
```
    Set user properties.
    
    Parameters:
    
    userProps - string containing user properties.
  - getPostalCode
```
public String getPostalCode()
```
    Return postal code.
    
    Returns:
    
    String containing postal code.
  - setPostalCode
```
public void setPostalCode(String postalCode)
```
    Set a postal code on address.
    
    Parameters:
    
    postalCode - String containing postal code.
  - getPostOfficeBox
```
public String getPostOfficeBox()
```
    Return post ofice box associated with a user.
    
    Returns:
    
    String containing postal code.
  - setPostOfficeBox
```
public void setPostOfficeBox(String postOfficeBox)
```
    Set a post office box
    
    Parameters:
    
    postOfficeBox - Sting containing post office box.
  - getBuilding
```
public String getBuilding()
```
    Return the building designator.
    
    Returns:
    
    String containing building designator.
  - setBuilding
```
public void setBuilding(String building)
```
    Set building designator.
    
    Parameters:
    
    building - Accept String containing building designator.
  - getDepartmentNumber
```
public String getDepartmentNumber()
```
    Return department number.
    
    Returns:
    
    String containing department number.
  - setDepartmentNumber
```
public void setDepartmentNumber(String departmentNumber)
```
    Set department number.
    
    Parameters:
    
    departmentNumber - Accept String containing department number.
  - getRoomNumber
```
public String getRoomNumber()
```
    Return room number.
    
    Returns:
    
    String containing room number.
  - setRoomNumber
```
public void setRoomNumber(String roomNumber)
```
    Set the room number.
    
    Parameters:
    
    roomNumber - Accept a String containing the room number.
  - getCity
```
public String getCity()
```
    Return the city name.
    
    Returns:
    
    String containing the city name.
  - setCity
```
public void setCity(String city)
```
    Set the city name.
    
    Parameters:
    
    city - Accept a String containing the city name for the user.
  - getState
```
public String getState()
```
    Return the state name.
    
    Returns:
    
    String containing the name of the State.
  - setState
```
public void setState(String state)
```
    Set the state name of the user.
    
    Parameters:
    
    state - Accept a String containing the state name.
  - getCountry
```
public String getCountry()
```
    Return the country name.
    
    Returns:
    
    String with country name.
  - setCountry
```
public void setCountry(String country)
```
    Set the country name
    
    Parameters:
    
    country - String containing user's country.
  - getPhone
```
public String getPhone()
```
    Return phone for a user.
    
    Returns:
    
    String containing phone number.
  - setPhone
```
public void setPhone(String phone)
```
    Set a phone on the user. The user object can store many phone number.
    
    Overrides:
    
    setPhone in class User
    
    Parameters:
    
    phone - contains String bound to telephoneNumber attribute on organizationalPerson object class.
  - getEmail
```
public String getEmail()
```
    Return email for user.
    
    Returns:
    
    String containing email.
  - setEmail
```
public void setEmail(String email)
```
    A User may have many phones set on their record.
    
    Overrides:
    
    setEmail in class User
    
    Parameters:
    
    email - contains a String to be stored as email address on user.
  - getMobile
```
public String getMobile()
```
    Return a mobile number for the user.
    
    Returns:
    
    String containing mobile number.
  - setMobile
```
public void setMobile(String mobile)
```
    Set a mobile number on the user. The user may have many mobiles.
    
    Overrides:
    
    setMobile in class User
    
    Parameters:
    
    mobile - contains a String containing mobile phone numbers associated with the user.
  - getPhoto
```
public String getPhoto()
```
    Return the user's jpg photo
    
    Returns:
    
    String
  - setPhoto
```
public void setPhoto(String photo)
```
    Set a photo on user's record
    
    Parameters:
    
    photo - The photo to store
  - readJpegFile
```
public static byte[] readJpegFile(String fileName)
```
    Read the image from specified file location and return as a byte array.
    
    Parameters:
    
    fileName - fully qualified file name
    
    Returns:
    
    byte array containing image

Class UserAnt

Field Summary

Fields inherited from class org.apache.directory.fortress.core.model.FortEntity

Constructor Summary

Method Summary

Methods inherited from class org.apache.directory.fortress.core.model.User

Methods inherited from class org.apache.directory.fortress.core.model.FortEntity

Methods inherited from class java.lang.Object

Constructor Detail

UserAnt

Method Detail

getAddresses

setAddresses

getUserProps

setUserProps

getPostalCode

setPostalCode

getPostOfficeBox

setPostOfficeBox

getBuilding

setBuilding

getDepartmentNumber

setDepartmentNumber

getRoomNumber

setRoomNumber

getCity

setCity

getState

setState

getCountry

setCountry

getPhone

setPhone

getEmail

setEmail

getMobile

setMobile

getPhoto

setPhoto

readJpegFile