DomainManagementMessages (JBoss Application Server: Parent Aggregator 7.1.1.Final API)

@MessageBundle(projectCode="JBAS")
public interface DomainManagementMessages

Date: 05.11.2011

Author:: James R. Perkins, Darran Lofthouse

Field Summary

Fields
Modifier and Type Field and Description

static DomainManagementMessages MESSAGES
The messages

Fields
Modifier and Type	Field and Description
`static DomainManagementMessages`	`MESSAGES` The messages

Method Summary

Methods
Modifier and Type	Method and Description
`String`	`aboutToAddUser(String username, String realm)` Confirmation of the user being added.
`String`	`aboutToUpdateUser(String user)` Confirmation if the current user password and roles is about to be updated.
`String`	`addedRoles(String username, String roles, String fileName)` Message to inform user that the new user has been added to the roles file identified.
`String`	`addedUser(String username, String fileName)` Message to inform user that the new user has been added to the file identified.
`IllegalArgumentException`	`canNotBeNull(String name)` Creates an IllegalArgumentException indicating that a value can not be null.
`IOException`	`cannotPerformVerification(Throwable cause)` Creates an exception indicating the verification could not be performed.
`String`	`duplicateUser(String user)` The error message if the user is already in at least one file.
`String`	`enterNewUserDetails()` A message prompting the user to enter the details of the user being added.
`String`	`errorHeader()` The error message header.
`String`	`filePrompt()` Prompt for the file to update in add-users
`String`	`invalidChoiceResponse()` The error message if the choice response is invalid.
`String`	`invalidConfirmationResponse()` The error message if the confirmation response is invalid.
`IllegalStateException`	`invalidRealm(String realm, String expectedRealm)` Creates an exception indicating the realm was invalid.
`String`	`isCorrectPrompt()` Prompt to ask user to confirm yes or no.
`String`	`jbossHomeNotSet()` A message indicating JBOSS_HOME not set.
`OperationFailedException`	`multipleAuthenticationMechanismsDefined(String realmName, Set<String> mechanisms)` Error message if more than one username/password authentication mechanism is defined.
`NamingException`	`nameNotFound(String name)` Creates an exception indicating the referral for authentication could not be followed.
`IllegalStateException`	`noAuthenticationDefined()` Creates an exception indicating no authentication mechanism was defined in the security realm.
`OperationFailedException`	`noAuthenticationDefined(String realmName)` Creates an exception indicating no authentication mechanism was defined in the security realm.
`IllegalStateException`	`noConsoleAvailable()` Creates an exception indicating that no java.io.Console is available.
`IOException`	`noPassword()` Creates an exception indicating no password was provided.
`String`	`noPasswordExiting()` The error message if no password is entered.
`String`	`noSecurityContextEstablished()` Creates a String for use in an OperationFailedException to indicate that no security context has been established for a call that requires one.
`IOException`	`noUsername()` Creates an exception indicating no username was provided.
`String`	`noUsernameExiting()` The error message if no username is entered.
`IllegalArgumentException`	`oneOfRequired(String attr1, String attr2)` Creates an exception indicating that one of `attr1` or `attr2` is required.
`OperationFailedException`	`operationFailedOneOfRequired(String attr1, String attr2)` Creates an exception indicating that one of `attr1` or `attr2` is required.
`OperationFailedException`	`operationFailedOnlyOneOfRequired(String attr1, String attr2)` Creates an exception indicating that only one of `attr1` or `attr2` is required.
`String`	`passwordConfirmationPrompt()` The prompt to obtain the password confirmation from the user.
`String`	`passwordMisMatch()` The error message if the passwords do not match.
`String`	`passwordPrompt()` The prompt to obtain the password from the user.
`String`	`propertiesFileNotFound(String file)` A message indicating no mgmt-users.properties have been found.
`UnsupportedCallbackException`	`realmNotSupported(Callback callback)` Creates an exception indicating the realm is not supported.
`String`	`realmPrompt(String realm)` The prompt to obtain the realm from the user.
`String`	`rolesPrompt()` Prompt the user for the roles to add the user to
`String`	`sureToAddUser(String username)` A prompt to double check the user is really sure they want to add this user.
`String`	`unableToAddUser(String file, String error)` The error message if adding the user to the file fails.
`org.jboss.msc.service.StartException`	`unableToLoadProperties(Throwable cause)` Creates an exception indicating the properties could not be loaded.
`String`	`unableToLoadUsers(String file, String error)` The error message if loading the known users from file fails.
`org.jboss.msc.service.StartException`	`unableToStart(Throwable cause)` Creates an exception indicating the inability to start the service.
`String`	`unableToUpdateUser(String absolutePath, String message)` The error message if updating user to the file fails.
`String`	`unexpectedNumberOfRealmUsers(int count)` Creates a String for use in an OperationFailedException to indicate that an unexpected number of RealmUser instances have been found.
`String`	`updatedRoles(String username, String roles, String fileName)` Message to inform user that the user has been updated to the roles file identified.
`String`	`updateUser(String userName, String canonicalPath)` Message to inform user that the user has been updated to the file identified.
`String`	`usernameEasyToGuess(String username)` Warning that the username is easy to guess.
`String`	`usernameNotAlphaNumeric()` The error message if the username is not alpha numeric
`String`	`usernamePasswordMatch()` The error message if the username and password are equal.
`String`	`usernamePrompt()` The prompt to obtain the new username from the user.
`String`	`usernamePrompt(String defaultUsername)` The prompt to obtain the new username from the user.
`String`	`userNotFound(String username)` A message indicating the user, represented by the `username` parameter, was not found.
`IOException`	`userNotFoundInDirectory(String username)` Creates an exception indicating the user, represented by the `username` parameter, was not found in the directory.

- Field Detail
  - MESSAGES
```
static final DomainManagementMessages MESSAGES
```
    The messages
- Method Detail
  - cannotPerformVerification
```
@Message(id=15220,
         value="Unable to perform verification")
IOException cannotPerformVerification(@Cause
                                            Throwable cause)
```
    Creates an exception indicating the verification could not be performed.
    
    Parameters:
    cause - the cause of the error.
    
    Returns:
    an IOException for the error.
  - invalidRealm
```
@Message(id=15221,
         value="Invalid Realm \'%s\' expected \'%s\'")
IllegalStateException invalidRealm(String realm,
                                         String expectedRealm)
```
    Creates an exception indicating the realm was invalid.
    
    Parameters:
    realm - the invalid realm.
    expectedRealm - the expected realm.
    
    Returns:
    an IllegalStateException for the error.
  - nameNotFound
```
@Message(id=15222,
         value="Can\'t follow referral for authentication: %s")
NamingException nameNotFound(String name)
```
    Creates an exception indicating the referral for authentication could not be followed.
    
    Parameters:
    name - the invalid name.
    
    Returns:
    a NamingException for the error.
  - noAuthenticationDefined
```
@Message(id=15223,
         value="No authentication mechanism defined in security realm.")
IllegalStateException noAuthenticationDefined()
```
    Creates an exception indicating no authentication mechanism was defined in the security realm.
    
    Returns:
    an IllegalStateException for the error.
  - noUsername
```
@Message(id=15224,
         value="No username provided.")
IOException noUsername()
```
    Creates an exception indicating no username was provided.
    
    Returns:
    an IOException for the error.
  - noPassword
```
@Message(id=15225,
         value="No password to verify.")
IOException noPassword()
```
    Creates an exception indicating no password was provided.
    
    Returns:
    an IOException for the error.
  - oneOfRequired
```
@Message(id=15226,
         value="One of \'%s\' or \'%s\' required.")
IllegalArgumentException oneOfRequired(String attr1,
                                             String attr2)
```
    Creates an exception indicating that one of attr1 or attr2 is required.
    
    Parameters:
    attr1 - the first attribute.
    attr2 - the second attribute.
    
    Returns:
    an IllegalArgumentException for the error.
  - realmNotSupported
```
@Message(id=15227,
         value="Realm choice not currently supported.")
UnsupportedCallbackException realmNotSupported(@Param
                                                     Callback callback)
```
    Creates an exception indicating the realm is not supported.
    
    Parameters:
    callback - the callback used to create the exception.
    
    Returns:
    an UnsupportedCallbackException for the error.
  - unableToLoadProperties
```
@Message(id=15228,
         value="Unable to load properties")
org.jboss.msc.service.StartException unableToLoadProperties(@Cause
                                                                  Throwable cause)
```
    Creates an exception indicating the properties could not be loaded.
    
    Parameters:
    cause - the cause of the error.
    
    Returns:
    a StartException for the error.
  - unableToStart
```
@Message(id=15229,
         value="Unable to start service")
org.jboss.msc.service.StartException unableToStart(@Cause
                                                         Throwable cause)
```
    Creates an exception indicating the inability to start the service.
    
    Parameters:
    cause - the cause of the error.
    
    Returns:
    a StartException for the error.
  - userNotFound
```
@Message(id=15230,
         value="User \'%s\' not found.")
String userNotFound(String username)
```
    A message indicating the user, represented by the username parameter, was not found.
    
    Parameters:
    username - the username not found.
    
    Returns:
    the message.
  - userNotFoundInDirectory
```
@Message(id=15231,
         value="User \'%s\' not found in directory.")
IOException userNotFoundInDirectory(String username)
```
    Creates an exception indicating the user, represented by the username parameter, was not found in the directory.
    
    Parameters:
    username - the username not found.
    
    Returns:
    an IOException for the error.
  - noConsoleAvailable
```
@Message(id=15232,
         value="No java.io.Console available to interact with user.")
IllegalStateException noConsoleAvailable()
```
    Creates an exception indicating that no java.io.Console is available.
    
    Returns:
    a IllegalStateException for the error.
  - jbossHomeNotSet
```
@Message(id=15233,
         value="JBOSS_HOME environment variable not set.")
String jbossHomeNotSet()
```
    A message indicating JBOSS_HOME not set.
    
    Returns:
    a String for the message.
  - propertiesFileNotFound
```
@Message(id=15234,
         value="No %s files found.")
String propertiesFileNotFound(String file)
```
    A message indicating no mgmt-users.properties have been found.
    
    Returns:
    a String for the message.
  - enterNewUserDetails
```
@Message(value="Enter the details of the new user to add.")
String enterNewUserDetails()
```
    A message prompting the user to enter the details of the user being added.
    
    Returns:
    a String for the message.
  - realmPrompt
```
@Message(value="Realm (%s)")
String realmPrompt(String realm)
```
    The prompt to obtain the realm from the user.
    
    Parameters:
    realm - - the default realm.
    
    Returns:
    a String for the message.
  - usernamePrompt
```
@Message(value="Username")
String usernamePrompt()
```
    The prompt to obtain the new username from the user.
    
    Returns:
    a String for the message.
  - usernamePrompt
```
@Message(value="Username (%s)")
String usernamePrompt(String defaultUsername)
```
    The prompt to obtain the new username from the user.
    
    Parameters:
    defaultUsername - - The default username if no value is entered.
    
    Returns:
    a String for the message.
  - noUsernameExiting
```
@Message(id=15235,
         value="No Username entered, exiting.")
String noUsernameExiting()
```
    The error message if no username is entered.
    
    Returns:
    a String for the message.
  - passwordPrompt
```
@Message(value="Password")
String passwordPrompt()
```
    The prompt to obtain the password from the user.
    
    Returns:
    a String for the message.
  - noPasswordExiting
```
@Message(id=15236,
         value="No Password entered, exiting.")
String noPasswordExiting()
```
    The error message if no password is entered.
    
    Returns:
    a String for the message.
  - passwordConfirmationPrompt
```
@Message(value="Re-enter Password")
String passwordConfirmationPrompt()
```
    The prompt to obtain the password confirmation from the user.
    
    Returns:
    a String for the message.
  - passwordMisMatch
```
@Message(id=15237,
         value="The passwords do not match.")
String passwordMisMatch()
```
    The error message if the passwords do not match.
    
    Returns:
    a String for the message.
  - usernamePasswordMatch
```
@Message(id=15238,
         value="Username must not match the password.")
String usernamePasswordMatch()
```
    The error message if the username and password are equal.
    
    Returns:
    a String for the message.
  - usernameNotAlphaNumeric
```
@Message(id=15239,
         value="Only alpha/numeric usernames accepted.")
String usernameNotAlphaNumeric()
```
    The error message if the username is not alpha numeric
    
    Returns:
    a String for the message.
  - aboutToAddUser
```
@Message(value="About to add user \'%s\' for realm \'%s\'")
String aboutToAddUser(String username,
                            String realm)
```
    Confirmation of the user being added.
    
    Parameters:
    username - - The new username.
    realm - - The realm the user is being added for.
    
    Returns:
    a String for the message.
  - isCorrectPrompt
```
@Message(value="Is this correct yes/no?")
String isCorrectPrompt()
```
    Prompt to ask user to confirm yes or no.
    
    Returns:
    a String for the message.
  - usernameEasyToGuess
```
@Message(value="The username \'%s\' is easy to guess")
String usernameEasyToGuess(String username)
```
    Warning that the username is easy to guess.
    
    Parameters:
    username - - The new username.
    
    Returns:
    a String for the message.
  - sureToAddUser
```
@Message(value="Are you sure you want to add user \'%s\' yes/no?")
String sureToAddUser(String username)
```
    A prompt to double check the user is really sure they want to add this user.
    
    Parameters:
    username - - The new username.
    
    Returns:
    a String for the message.
  - invalidConfirmationResponse
```
@Message(id=15240,
         value="Invalid response. (Valid responses are yes, y, no, and n)")
String invalidConfirmationResponse()
```
    The error message if the confirmation response is invalid. TODO - On translation we will need support for checking the possible responses.
    
    Returns:
    a String for the message.
  - addedUser
```
@Message(value="Added user \'%s\' to file \'%s\'")
String addedUser(String username,
                       String fileName)
```
    Message to inform user that the new user has been added to the file identified.
    
    Parameters:
    username - - The new username.
    fileName - - The file the user has been added to.
    
    Returns:
    a String for the message.
  - unableToAddUser
```
@Message(id=15241,
         value="Unable to add user to %s due to error %s")
String unableToAddUser(String file,
                             String error)
```
    The error message if adding the user to the file fails.
    
    Parameters:
    file - - The name of the file the add failed for.
    error - - The failure message.
    
    Returns:
    a String for the message.
  - unableToLoadUsers
```
@Message(id=15242,
         value="Unable to add load users from %s due to error %s")
String unableToLoadUsers(String file,
                               String error)
```
    The error message if loading the known users from file fails.
    
    Parameters:
    file - - The name of the file the load failed for.
    error - - The failure message.
    
    Returns:
    a String for the message.
  - duplicateUser
```
@Message(id=15243,
         value="The user \'%s\' already exists in at least one properties file.")
String duplicateUser(String user)
```
    The error message if the user is already in at least one file.
    
    Parameters:
    user - - The name of the user.
    
    Returns:
    a String for the message.
  - errorHeader
```
@Message(value="Error")
String errorHeader()
```
    The error message header.
    
    Returns:
    a String for the message.
  - multipleAuthenticationMechanismsDefined
```
@Message(id=15244,
         value="Configuration for security realm \'%s\' includes multiple username/password based authentication mechanisms (%s). Only one is allowed")
OperationFailedException multipleAuthenticationMechanismsDefined(String realmName,
                                                                       Set<String> mechanisms)
```
    Error message if more than one username/password authentication mechanism is defined.
    
    Parameters:
    realmName - the name of the security realm
    mechanisms - the set of mechanisms .
    
    Returns:
    an OperationFailedException for the error.
  - noAuthenticationDefined
```
@Message(id=15245,
         value="No authentication mechanism defined in security realm \'%s\'.")
OperationFailedException noAuthenticationDefined(String realmName)
```
    Creates an exception indicating no authentication mechanism was defined in the security realm.
    
    Parameters:
    realmName - the security realm name
    
    Returns:
    an OperationFailedException for the error.
  - operationFailedOneOfRequired
```
@Message(id=15246,
         value="One of \'%s\' or \'%s\' required.")
OperationFailedException operationFailedOneOfRequired(String attr1,
                                                            String attr2)
```
    Creates an exception indicating that one of attr1 or attr2 is required.
    
    Parameters:
    attr1 - the first attribute.
    attr2 - the second attribute.
    
    Returns:
    an OperationFailedException for the error.
  - operationFailedOnlyOneOfRequired
```
@Message(id=15247,
         value="Only one of \'%s\' or \'%s\' is required.")
OperationFailedException operationFailedOnlyOneOfRequired(String attr1,
                                                                String attr2)
```
    Creates an exception indicating that only one of attr1 or attr2 is required.
    
    Parameters:
    attr1 - the first attribute.
    attr2 - the second attribute.
    
    Returns:
    an OperationFailedException for the error.
  - canNotBeNull
```
@Message(id=15248,
         value="\'%s\' can not be null.")
IllegalArgumentException canNotBeNull(String name)
```
    Creates an IllegalArgumentException indicating that a value can not be null.
    
    Parameters:
    name - - The name of the parameter that can not be null.
    
    Returns:
    an IllegalArgumentException for the error.
  - noSecurityContextEstablished
```
@Message(id=15249,
         value="No security context has been established.")
String noSecurityContextEstablished()
```
    Creates a String for use in an OperationFailedException to indicate that no security context has been established for a call that requires one.
  - unexpectedNumberOfRealmUsers
```
@Message(id=15250,
         value="An unexpected number (%d) of RealmUsers are associated with the SecurityContext.")
String unexpectedNumberOfRealmUsers(int count)
```
    Creates a String for use in an OperationFailedException to indicate that an unexpected number of RealmUser instances have been found.
    
    Parameters:
    count - - The number of RealmUser instances found.
  - filePrompt
```
@Message(value="What type of user do you wish to add? %n a) Management User (mgmt-users.properties) %n b) Application User (application-users.properties)")
String filePrompt()
```
    Prompt for the file to update in add-users
  - rolesPrompt
```
@Message(value="What roles do you want this user to belong to? (Please enter a comma separated list, or leave blank for none)")
String rolesPrompt()
```
    Prompt the user for the roles to add the user to
    
    Returns:
  - addedRoles
```
@Message(value="Added user \'%s\' with roles %s to file \'%s\'")
String addedRoles(String username,
                        String roles,
                        String fileName)
```
    Message to inform user that the new user has been added to the roles file identified.
    
    Parameters:
    username - - The new username.
    roles - - The new roles.
    fileName - - The file the user has been added to.
    
    Returns:
    a String for the message.
  - invalidChoiceResponse
```
@Message(id=15251,
         value="Invalid response. (Valid responses are A, a, B, or b)")
String invalidChoiceResponse()
```
    The error message if the choice response is invalid. TODO - On translation we will need support for checking the possible responses.
    
    Returns:
    a String for the message.
  - aboutToUpdateUser
```
@Message(value="User \'%s\' already exits, would you like to update the existing user password and roles")
String aboutToUpdateUser(String user)
```
    Confirmation if the current user password and roles is about to be updated.
    
    Parameters:
    user - - The name of the user.
    
    Returns:
    a String for the message.
  - updateUser
```
@Message(value="Updated user \'%s\' to file \'%s\'")
String updateUser(String userName,
                        String canonicalPath)
```
    Message to inform user that the user has been updated to the file identified.
    
    Parameters:
    username - - The new username.
    fileName - - The file the user has been added to.
    
    Returns:
    a String for the message.
  - unableToUpdateUser
```
@Message(id=15254,
         value="Unable to update user to %s due to error %s")
String unableToUpdateUser(String absolutePath,
                                String message)
```
    The error message if updating user to the file fails.
    
    Parameters:
    file - - The name of the file the add failed for.
    error - - The failure message.
    
    Returns:
    a String for the message.
  - updatedRoles
```
@Message(value="Updated user \'%s\' with roles %s to file \'%s\'")
String updatedRoles(String username,
                          String roles,
                          String fileName)
```
    Message to inform user that the user has been updated to the roles file identified.
    
    Parameters:
    username - - The new username.
    roles - - The new roles.
    fileName - - The file the user has been added to.
    
    Returns:
    a String for the message.

Interface DomainManagementMessages

Field Summary

Method Summary

Field Detail

MESSAGES

Method Detail

cannotPerformVerification

invalidRealm

nameNotFound

noAuthenticationDefined

noUsername

noPassword

oneOfRequired

realmNotSupported

unableToLoadProperties

unableToStart

userNotFound

userNotFoundInDirectory

noConsoleAvailable

jbossHomeNotSet

propertiesFileNotFound

enterNewUserDetails

realmPrompt

usernamePrompt

usernamePrompt

noUsernameExiting

passwordPrompt

noPasswordExiting

passwordConfirmationPrompt

passwordMisMatch

usernamePasswordMatch

usernameNotAlphaNumeric

aboutToAddUser

isCorrectPrompt

usernameEasyToGuess

sureToAddUser

invalidConfirmationResponse

addedUser

unableToAddUser

unableToLoadUsers

duplicateUser

errorHeader

multipleAuthenticationMechanismsDefined

noAuthenticationDefined

operationFailedOneOfRequired

operationFailedOnlyOneOfRequired

canNotBeNull

noSecurityContextEstablished

unexpectedNumberOfRealmUsers

filePrompt

rolesPrompt

addedRoles

invalidChoiceResponse

aboutToUpdateUser

updateUser

unableToUpdateUser

updatedRoles