Interface SubjectMapper


  • public interface SubjectMapper
    An interface for mapping subjects.
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Interface Description
      static class  SubjectMapper.Context
      Added to a mapped subject prefix
    • Field Detail

      • MAPPED_PREFIX_EXTENSION

        static final java.lang.String MAPPED_PREFIX_EXTENSION
        See Also:
        Constant Field Values
    • Method Detail

      • initialise

        void initialise​(SubjectMapper.Context context)

        This notifies the SubjectMapper that it is about to be loaded. This method will be called by the system once.

        You should use this method to perform any initialisation required before the SubjectMapper is loaded by the system.

      • apply

        java.lang.String apply​(java.lang.String subject)

        Given a subject, returns a mapping to a new subject. Future requests for the given subject will be redirected to the new subject.

        You should use this method to return a mapping for the given subject.

        Returns:
        the mapped subject.