Subversion Repository Public Repository

litesoft

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
// This Source Code is in the Public Domain per: http://unlicense.org
package InterModuleComm;

import org.litesoft.commonfoundation.base.*;
import org.litesoft.commonfoundation.typeutils.*;

import java.util.*;

public final class ToMessage implements Message {
    protected static final String PREFIX = Constants.PROTOCOL_PREFIX + ModuleMsgLifecycleForm.To + Constants.NV_SEP;
    protected static final String FROM_PREFIX = "From" + Constants.NV_SEP;
    protected static final String ERROR_PREFIX = "Error" + Constants.NV_SEP;
    protected static final String TERMINATOR_PREFIX = "Terminator" + Constants.NV_SEP;
    protected static final String ONELINE_PREFIX = "OneLine" + Constants.NV_SEP;
    protected static final String NOLINES = "NoLines";
    protected static final String INITIAL_TERMINATOR = "-----";

    private ToMsgForm mForm;
    private String mFrom;
    private String mTo;
    private String mId;
    private String mError;
    private String mTerminatingMsgLine;

    private final String[] mMsgLines;

    protected ToMessage( ToMsgForm pForm, String pFrom, String pTo, String pId, String pError,
                         String pTerminatingMsgLine, String[] pMsgLines ) {
        mForm = pForm;
        mFrom = pFrom;
        mTo = pTo;
        mId = pId;
        mError = pError;
        mTerminatingMsgLine = pTerminatingMsgLine;
        mMsgLines = pMsgLines;
    }

    public String[] getMsgLines() {
        return (mMsgLines != null) ? mMsgLines.clone() : null;
    }

    public String getMsgBody() {
        return (mError != null) || (mMsgLines == null) || (mMsgLines.length == 0) ? null :
               LowLevelBuildMsgBody();
    }

    private String LowLevelBuildMsgBody() {
        StringBuilder sb = new StringBuilder();
        for ( String line : mMsgLines ) {
            sb.append( line ).append( '\n' );
        }
        sb.append( mTerminatingMsgLine );
        return sb.toString();
    }

    @Override
    public String toString() {
        return CombinedHeaderAndMsgBody();
    }

    private String CombinedHeaderAndMsgBody() {
        String rv = getHeader();
        if ( (mMsgLines != null) && (mMsgLines.length > 1) ) {
            rv += "\n" + LowLevelBuildMsgBody();
        }
        return rv;
    }

    public String ToSendText() {
        return CombinedHeaderAndMsgBody() + "\n";
    }

    public String getHeader() {
        String rv = PREFIX + mTo + " " + FROM_PREFIX + mFrom + " " + mForm + Constants.NV_SEP + mId;
        if ( mError != null ) {
            rv += " " + ERROR_PREFIX + mError;
        } else if ( (mMsgLines == null) || (mMsgLines.length == 0) ) {
            rv += " " + NOLINES;
        } else if ( mMsgLines.length == 1 ) {
            rv += " " + ONELINE_PREFIX + mMsgLines[0];
        } else if ( !Currently.isNullOrEmpty( mTerminatingMsgLine ) ) {
            rv += " " + TERMINATOR_PREFIX + mTerminatingMsgLine;
        }
        return rv;
    }

    public ToMsgForm getForm() {
        return mForm;
    }

    public String getFrom() {
        return mFrom;
    }

    public String getTo() {
        return mTo;
    }

    public String getId() {
        return mId;
    }

    public String getError() {
        return mError;
    }

    public String getTerminatingMsgLine() {
        return mTerminatingMsgLine;
    }

    public static class Builder {
        public static Builder FromHeader( String pHeader ) {
            if ( (pHeader != null) && pHeader.startsWith( PREFIX ) ) {
                //String zRest = Utils.trimLeadingSpaces( pHeader.substring( PREFIX.length() ));
                RestOfMsg vRestOfMsg =
                        new RestOfMsg( Strings.trimLeadingSpaces( pHeader.substring( PREFIX.length() ) ) );
                String zTo = thru( ' ', vRestOfMsg ); // ref is reference. Create zRest object
                if ( vRestOfMsg.getRest().startsWith( FROM_PREFIX ) ) {
                    vRestOfMsg.setRest( Strings.trimLeadingSpaces(
                            vRestOfMsg.getRest().substring( FROM_PREFIX.length() ) ) );
                    String zFrom = thru( ' ', vRestOfMsg );
                    ToMsgForm zForm = convertToMsgForm( thru( Constants.NV_SEP, vRestOfMsg ) );
                    if ( zForm != null ) {
                        vRestOfMsg.setRest( Strings.trimLeadingSpaces( vRestOfMsg.getRest().substring( 1 ) ) );
                        String zId = thru( ' ', vRestOfMsg );
                        String zError = null;
                        String zTerminator = "";
                        boolean zNoLines = false;
                        String zOneLine = null;
                        if ( vRestOfMsg.getRest().startsWith( ERROR_PREFIX ) ) {
                            zError = vRestOfMsg.getRest().substring( ERROR_PREFIX.length() ).trim();
                        } else if ( vRestOfMsg.getRest().equals( NOLINES ) ) {
                            zNoLines = true;
                        } else if ( vRestOfMsg.getRest().startsWith( ONELINE_PREFIX ) ) {
                            zOneLine = vRestOfMsg.getRest().substring( ONELINE_PREFIX.length() );
                        } else if ( vRestOfMsg.getRest().startsWith( TERMINATOR_PREFIX ) ) {
                            zTerminator = vRestOfMsg.getRest().substring( TERMINATOR_PREFIX.length() ).trim();
                        }
                        Builder rv = fromParams( zForm, zFrom, zTo, zId, zError );
                        if ( rv != null ) {
                            rv.mLinesTerminatorFromHeader = zTerminator;
                            if ( zNoLines || (zOneLine != null) ) {
                                if ( zOneLine != null ) {
                                    if ( !rv.LowLevelAddMsgLine( zOneLine ) ) {
                                        return null;
                                    }
                                }
                                rv.mMsgLinesTerminated = true;
                            }
                            return rv;
                        }
                    }
                }
            }
            return null;
        }

        public static class RestOfMsg {
            private String mRest;

            public RestOfMsg( String pRest ) {
                mRest = pRest;
            }

            public String getRest() {
                return mRest;
            }

            public void setRest( String pRest ) {
                mRest = pRest;
            }
        }

        private static ToMsgForm convertToMsgForm( String pStr ) {
            try {
                return ToMsgForm.valueOf( pStr );
            }
            catch ( IllegalArgumentException ex ) {
                return null;
            }
        }

        //private static String thru( char pSep, ref String pLine )
        private static String thru( char pSep, RestOfMsg pLine ) {
            String rv;
            int zAt = pLine.getRest().indexOf( pSep );
            if ( zAt == -1 ) {
                rv = pLine.getRest();
                pLine.setRest( "" );
            } else {
                rv = pLine.getRest().substring( 0, zAt );
                pLine.setRest( Strings.trimLeadingSpaces( pLine.getRest().substring( zAt ) ) );
            }
            return rv;
        }

        private Builder( ToMsgForm pForm, String pFrom, String pTo, String pId, String pError ) {
            mForm = pForm;
            mFrom = pFrom;
            mTo = pTo;
            mId = pId;
            mError = pError;
        }

        private static Builder fromParams( ToMsgForm pForm, String pFrom, String pTo, String pId,
                                           String pError ) {
            pFrom = ConstrainTo.significantOrNull( pFrom );
            pTo = ConstrainTo.significantOrNull( pTo );
            pId = ConstrainTo.significantOrNull( pId );

            if ( Strings.isAsciiIdentifier( pFrom ) && Strings.isAsciiIdentifier( pTo ) && Strings.isNoSpaceAscii( pId ) ) {
                return new Builder( pForm, pFrom, pTo, pId, ConstrainTo.significantOrNull( pError ) );
            }
            return null;
        }

        public static Builder Notify( String pFrom, String pTo, String pId, String pError ) {
            return fromParams( ToMsgForm.Notify, pFrom, pTo, pId, pError );
        }

        public static Builder Notify( String pFrom, String pTo, String pId ) {
            return Notify( pFrom, pTo, pId, null );
        }

        public static Builder Request( String pFrom, String pTo, String pId ) {
            return fromParams( ToMsgForm.Request, pFrom, pTo, pId, null );
        }

        public static Builder Reply( ToMessage pReplyTo, String pError ) {
            if ( pReplyTo == null ) {
                throw new NullPointerException( "pReplyTo" );
            }
            return fromParams( ToMsgForm.Reply, pReplyTo.mTo, pReplyTo.mFrom, pReplyTo.mId, pError );
        }

        public static Builder Reply( ToMessage pReplyTo ) {
            return Reply( pReplyTo, null );
        }

        public void AddMsgLine( String pLine ) {
            if ( pLine == null ) {
                throw new IllegalStateException( "May Not add a Null line" );
            }
            if ( mMsgLinesTerminated ) {
                throw new IllegalStateException(
                        "May Not add any more lines after the the Message Lines have been Terminated" );
            }
            if ( mError != null ) {
                throw new IllegalStateException( "May Not add lines to an Error'd Message" );
            }
            mAnyEmptyMsgLines |= (pLine.length() == 0);
            while ( pLine.startsWith( mLinesTerminatorEvolving ) ) {
                mLinesTerminatorEvolving += "-";
            }
            if ( pLine.equals( mLinesTerminatorFromHeader ) ) {
                mMsgLinesTerminated = true;
                return;
            }
            if ( !LowLevelAddMsgLine( pLine ) ) {
                throw new IllegalStateException(
                        "May Not add lines with Control Characters (< ' ') to a Message" );
            }
        }

        // return true if line is empty || consists of characters which are >= ' '
        protected boolean LowLevelAddMsgLine( String pLine ) {
            for ( int i = 0; i < pLine.length(); i++ ) {
                if ( pLine.charAt( i ) < ' ' ) {
                    return false;
                }
            }
            mMsgLines.add( pLine );
            return true;
        }

        private ToMsgForm mForm;
        private String mFrom;
        private String mTo;
        private String mId;
        private String mError;

        private String mLinesTerminatorFromHeader;

        private String mLinesTerminatorEvolving = INITIAL_TERMINATOR;
        private boolean mAnyEmptyMsgLines;

        private boolean mMsgLinesTerminated;

        private final List<String> mMsgLines = new ArrayList<String>();

        public List<String> getMsgLines() {
            return mMsgLines;
        }

        public ToMessage ToMsg() {
            String zTerminator = null;
            String[] zMsgLines = null;
            if ( mError == null ) {
                zMsgLines = mMsgLines.toArray( new String[mMsgLines.size()] );
                mMsgLinesTerminated = true;
                if ( null == (zTerminator = mLinesTerminatorFromHeader) ) // Not Header Terminated
                {
                    zTerminator = mAnyEmptyMsgLines ? mLinesTerminatorEvolving : "";
                }
            }
            return new ToMessage( mForm, mFrom, mTo, mId, mError, zTerminator, zMsgLines );
        }

        public boolean ExpectsMoreLines() {
            return ((mError == null) && !mMsgLinesTerminated);
        }

        public ToMsgForm getForm() {
            return mForm;
        }

        public void setForm( ToMsgForm pForm ) {
            mForm = pForm;
        }

        public String getFrom() {
            return mFrom;
        }

        public void setFrom( String pFrom ) {
            mFrom = pFrom;
        }

        public String getTo() {
            return mTo;
        }

        public void setTo( String pTo ) {
            mTo = pTo;
        }

        public String getId() {
            return mId;
        }

        public void setId( String pId ) {
            mId = pId;
        }

        public String getError() {
            return mError;
        }

        public void setError( String pError ) {
            mError = pError;
        }

        public String getLinesTerminatorFromHeader() {
            return mLinesTerminatorFromHeader;
        }

        public void setLinesTerminatorFromHeader( String pLinesTerminatorFromHeader ) {
            mLinesTerminatorFromHeader = pLinesTerminatorFromHeader;
        }

        public boolean isMsgLinesTerminated() {
            return mMsgLinesTerminated;
        }

        public void setMsgLinesTerminated( boolean pMsgLinesTerminated ) {
            mMsgLinesTerminated = pMsgLinesTerminated;
        }
    }
}

Commits for litesoft/trunk/Java/InterModuleComm/InterModuleComm/src/InterModuleComm/ToMessage.java

Diff revisions: vs.
Revision Author Commited Message
950 Diff Diff GeorgeS picture GeorgeS Thu 19 Jun, 2014 17:57:04 +0000

New Lines

948 Diff Diff GeorgeS picture GeorgeS Sat 07 Jun, 2014 23:42:39 +0000

Jusefuls Formatter Updated to New Code Format

947 Diff Diff GeorgeS picture GeorgeS Fri 06 Jun, 2014 23:36:56 +0000

Correct Spelling of package!

939 Diff Diff GeorgeS picture GeorgeS Mon 02 Jun, 2014 21:30:31 +0000

Extracting commonfoundation

821 Diff Diff GeorgeS picture GeorgeS Sun 19 Aug, 2012 00:08:41 +0000
802 Diff Diff GeorgeS picture GeorgeS Wed 15 Aug, 2012 04:04:47 +0000
801 Diff Diff GeorgeS picture GeorgeS Wed 15 Aug, 2012 03:59:02 +0000
610 Diff Diff GeorgeS picture GeorgeS Mon 12 Mar, 2012 00:54:00 +0000
49 Diff Diff GeorgeS picture GeorgeS Mon 12 Apr, 2010 02:59:10 +0000

License Text

2 GeorgeS picture GeorgeS Sun 07 Feb, 2010 12:50:58 +0000