Class ConnectionAutomatonImpl<CON>

    • Method Detail

      • isOpenable

        public boolean isOpenable​(CON aConnection)
        Determines whether the given connection may get opened, if true then component may open a connection with the given connection via the ConnectionOpenable.open(Object) method. Usually no physical connection is established; usually criteria describing the provided connection are evaluated; for example the connection is tested against a black list, a white list or against well-formedness or whether the specified protocols are supported (in case of a connection being a String URL beginning with "http://", "ftp://" or similar). --------------------------------------------------------------------- CAUTION: Even in case true is returned, the actual opening of a connection may fail (e.g. due to network failure or authentication issues). ---------------------------------------------------------------------
        Specified by:
        isOpenable in interface ConnectionOpenable.ConnectionOpenAutomaton<CON>
        Parameters:
        aConnection - The connection for which to determine whether it can be used to open a connection.
        Returns:
        True if ConnectionOpenable.open(Object) is theoretically possible.
      • open

        public void open​(CON aConnection)
                  throws OpenException
        Opens the component with the given connection.
        Specified by:
        open in interface ConnectionOpenable<CON>
        Parameters:
        aConnection - The connection used for opening the connection.
        Throws:
        OpenException - Thrown in case opening or accessing an open line (connection, junction, link) caused problems.
      • isOpened

        public boolean isOpened​()
        Retrieves the is-opened property from the opened property. Determines whether the component's connection is opened. A component's connection is opened after being opened as of Openable.open() or ConnectionOpenable.open(Object).
        Specified by:
        isOpened in interface OpenedAccessor
        Returns:
        True in case of being opened (returns the is-opened property stored by the opened property).
      • isClosed

        public boolean isClosed​()
        Retrieves the is-closed status. Determines whether the component's connection is closed. A component's connection is closed after being closed as of Closable.close().
        Specified by:
        isClosed in interface ClosedAccessor
        Returns:
        True in case of being closed.
      • close

        public void close​()
        Closes the component's connection(s). Throws a CloseException as upon close we may have to do things like flushing buffers which can fail (and would otherwise fail unhandled or even worse unnoticed).
        Specified by:
        close in interface Closable