Class JMRIClientReporterManager

    • Method Detail

      • createNewReporter

        protected Reporter createNewReporter​(@Nonnull
                                             java.lang.String systemName,
                                             java.lang.String userName)
                                      throws java.lang.IllegalArgumentException
        Description copied from class: AbstractReporterManager
        Internal method to invoke the factory, after all the logic for returning an existing Reporter has been invoked.
        Specified by:
        createNewReporter in class AbstractReporterManager
        systemName - system name.
        userName - username.
        never null
      • validateSystemNameFormat

        public java.lang.String validateSystemNameFormat​(@Nonnull
                                                         java.lang.String name,
                                                         java.util.Locale locale)
                                                  throws NamedBean.BadSystemNameException
        Validates to only numeric system names. Validate the format of name, returning it unchanged if valid.

        Although further restrictions may be added by system-specific implementations, at a minimum, the implementation must consider a name that does not start with the System Name prefix for this manager to be invalid, and must consider a name that is the same as the System Name prefix to be invalid.

        Overriding implementations may rely on Manager.validSystemNameFormat(java.lang.String), however they must provide an actionable message in the thrown exception if that method does not return Manager.NameValidity.VALID. When overriding implementations of this method rely on validSystemNameFormat(), implementations of that method must not throw an exception, log an error, or otherwise disrupt the user.

        name - the system name to validate
        locale - the locale for a localized exception; this is needed for the JMRI web server, which supports multiple locales
        the unchanged value of the name parameter
        NamedBean.BadSystemNameException - if provided name is an invalid format